Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add dependency metrics #774

Merged
merged 19 commits into from
Apr 20, 2023
+841 −43
Merged

feat: add dependency metrics #774

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
38e5655
feat: add initial metrics support
akashsinghal Mar 27, 2023
f10979f
Merge branch 'main' into akashsinghal/metrics
akashsinghal Mar 28, 2023
78f4ecd
first pass at adding more metrics
akashsinghal Mar 29, 2023
6eb4314
feat: add initial metrics support
akashsinghal Apr 5, 2023
0b91093
Merge branch 'main' into akashsinghal/metrics
akashsinghal Apr 5, 2023
acfcd86
merge upstream
akashsinghal Apr 5, 2023
088f069
merge main
akashsinghal Apr 5, 2023
aeb32c9
update metrics
akashsinghal Apr 11, 2023
caf3f04
Merge branch 'main' into akashsinghal/moreMetrics
akashsinghal Apr 11, 2023
19eb98d
Merge branch 'main' into akashsinghal/moreMetrics
akashsinghal Apr 12, 2023
46f61d7
add blob cache and cert metrics
akashsinghal Apr 13, 2023
12eaf3f
add tests
akashsinghal Apr 13, 2023
fbefecc
update docs
akashsinghal Apr 14, 2023
5d0411a
add azure specific dashboard pane
akashsinghal Apr 14, 2023
7748618
Merge branch 'main' into akashsinghal/moreMetrics
akashsinghal Apr 14, 2023
1bbb422
merge main
akashsinghal Apr 17, 2023
66f2d10
Merge branch 'main' into akashsinghal/moreMetrics
binbin-li Apr 18, 2023
d5f0d33
address comments
akashsinghal Apr 18, 2023
97c2b7d
Merge branch 'main' into akashsinghal/moreMetrics
akashsinghal Apr 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 17 additions & 8 deletions docs/reference/instrumentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,22 @@ Metrics Types:
- Gauge: Point-in-time value of a continuous data stream (e.g file system size, speed, pressure)
- Histogram: Aggregation of counters where each bin is bounded from the min value (0) to the upper bin boundary. For example if we had bin boundaries [0, 1, 2, 3, 4, 5] and the measured value is 3.5, then the resulting histogram would be [0, 0, 0, 1, 1].

| Name | Type | Unit | Description |
|:---------------------------:| --------- |:------------:|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ratify_verification_request | Histogram | milliseconds | Duration of a single request to the `/verify` endpoint. Histogram bins: [0, 10, 30, 50, 100, 200, 300, 400, 500, 600, 700, 800, 900, 1000, 1100, 1200, 1400, 1600, 1800, 2000, 2300, 2600, 4000, 4400, 4900] |
| ratify_mutation_request | Histogram | milliseconds | Duration of a single request to the `/mutate` endpoint. Histogram bins: [0, 10, 30, 50, 100, 200, 300, 400, 500, 600, 700, 800, 900, 1000, 1100, 1200, 1400, 1600, 1800] |
| ratify_verifier_duration | Histogram | milliseconds | Duration of a single verifier's execution for a single referrer artifact. Histogram bins: [0, 10, 50, 100, 200, 300, 400, 600, 800, 1100, 1500, 2000] |
| ratify_system_error_count | Counter | N/A | Count of errors emitted by http handlers |

| Name | Type | Unit | Attributes | Description |
|:-----------------------------:| --------- |:------------:| ---------------------------------------------------------------------------------------------------------------------------------------------------- |:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| ratify_verification_request | Histogram | milliseconds | N/A | Duration of a single request to the `/verify` endpoint. Histogram bins: `[0, 10, 30, 50, 100, 200, 300, 400, 500, 600, 700, 800, 900, 1000, 1100, 1200, 1400, 1600, 1800, 2000, 2300, 2600, 4000, 4400, 4900]` |
| ratify_mutation_request | Histogram | milliseconds | N/A | Duration of a single request to the `/mutate` endpoint. Histogram bins: `[0, 10, 30, 50, 100, 200, 300, 400, 500, 600, 700, 800, 900, 1000, 1100, 1200, 1400, 1600, 1800]` |
| ratify_verifier_duration | Histogram | milliseconds | `verifier`: name of the verifier <br/> `subject`: full subject reference <br/> `success`: verifier result <br/> `error`: if operation returned error | Duration of a single verifier's execution for a single referrer artifact. Histogram bins: `[0, 10, 50, 100, 200, 300, 400, 600, 800, 1100, 1500, 2000]` |
| ratify_system_error_count | Counter | N/A | `error`: error message | Count of errors emitted by http handlers |
| ratify_registry_request_count | Counter | N/A | `status_code`: registry request status code <br/> `registry_host`: registry host name | Count of requests made to registry |
| ratify_blob_cache_count | Counter | N/A | `hit`: boolean cache hit | Count of ORAS blob cache hit/miss | |

### Azure Metrics

| Name | Type | Unit | Attributes | Description |
| ------------------------------- | --------- | ------------ | --------------------------------------------------------------- | --------------------------------------------------------------- |
| ratify_aad_exchange_duration | Histogram | milliseconds | `resource_type`: resource scope (ACR vs AKV) | Duration of federated JWT exchange for AAD resource scope token |
| ratify_acr_exchange_duration | Histogram | milliseconds | `repository`: full ACR repository name for token exchange scope | Duration of exchange of AAD token for ACR refresh token |
| ratify_akv_certificate_duration | Histogram | milliseconds | `certificate_name`: name of AKV certificate object | Duration of AKV certificate fetch operation |

## Metrics Providers Supported

Expand Down Expand Up @@ -89,4 +98,4 @@ Prior to installing Ratify on the cluster:
>Note: There is only support for a single metric exporter at a time

Additional metrics exporters can be added as metrics backends.
The exporter must be initialized in the `InitMetricsExporter` method as a new exporter type. Each exporter type is determined from the `metricsBackend` parameter. During metric exporter initialization a new metric reader must be instantiated and assigned to the static global variable `MetricsReader`. Once registered, the global `MetricsReader` is used to initialize OpenTelemetry meter and instruments.
The exporter must be initialized in the `InitMetricsExporter` method as a new exporter type. Each exporter type is determined from the `metricsBackend` parameter. During metric exporter initialization a new metric reader must be instantiated and assigned to the static global variable `MetricsReader`. Once registered, the global `MetricsReader` is used to initialize OpenTelemetry meter and instruments.
Loading