Skip to content

Commit 4e0b089

Browse files
pichlermarcpichlermarc
committed
add column for ucum units. change default unit to annotation in faas-metrics.
1 parent bb71f1e commit 4e0b089

File tree

3 files changed

+34
-34
lines changed

3 files changed

+34
-34
lines changed

‎specification/metrics/semantic_conventions/faas-metrics.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -32,22 +32,22 @@ type and units.
3232

3333
Below is a table of FaaS invocation metric instruments.
3434

35-
| Name | Instrument | Units | Description |
36-
|------|------------|----|-------------|
37-
| `faas.invoke_duration` | Histogram | ms | Measures the duration of the invocation in milliseconds |
38-
| `faas.init_duration` | Histogram | ms | Measures the duration of the function's initialization, such as a cold start, in milliseconds |
39-
| `faas.coldstarts` | Counter | 1 | Number of invocation cold starts. |
40-
| `faas.errors` | Counter | 1 | Number of invocation errors. |
41-
| `faas.executions` | Counter | 1 | Number of successful invocations. |
42-
| `faas.timeouts` | Counter | 1 | Number of invocation timeouts. |
35+
| Name | Instrument | Unit | Unit (UCUM) | Description |
36+
|------|------------|------|-------------|-------------|
37+
| `faas.invoke_duration` | Histogram | milliseconds |`ms` | Measures the duration of the invocation |
38+
| `faas.init_duration` | Histogram | milliseconds | `ms` | Measures the duration of the function's initialization, such as a cold start |
39+
| `faas.coldstarts` | Counter | default unit | `{coldstarts}` | Number of invocation cold starts. |
40+
| `faas.errors` | Counter | default unit | `{errors}` | Number of invocation errors. |
41+
| `faas.executions` | Counter | default unit |`{executions}` | Number of successful invocations. |
42+
| `faas.timeouts` | Counter | default unit | `{timeouts}` | Number of invocation timeouts. |
4343

4444
Optionally, when applicable:
4545

46-
| Name | Instrument | Units | Description |
47-
|------|------------|----|-------------|
48-
| `faas.mem_usage` | Histogram | By | Distribution of max memory usage per invocation in bytes |
49-
| `faas.cpu_usage` | Histogram | ms | Distribution of cpu usage per invocation in milliseconds |
50-
| `faas.net_io` | Histogram | By | Distribution of net I/O usage per invocation in bytes|
46+
| Name | Instrument | Unit | Unit (UCUM) | Description |
47+
|------|------------|------|-------------|-------------|
48+
| `faas.mem_usage` | Histogram | Bytes | `By` | Distribution of max memory usage per invocation |
49+
| `faas.cpu_usage` | Histogram | milliseconds | `ms` | Distribution of cpu usage per invocation |
50+
| `faas.net_io` | Histogram | Bytes | `By` | Distribution of net I/O usage per invocation |
5151

5252
## Attributes
5353

‎specification/metrics/semantic_conventions/http-metrics.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -17,18 +17,18 @@ type and units.
1717

1818
Below is a table of HTTP server metric instruments.
1919

20-
| Name | Instrument | Units | Description |
21-
|-------------------------------|----------------------------|------------|-------------|
22-
| `http.server.duration` | Histogram | ms | measures the duration of the inbound HTTP request in milliseconds |
23-
| `http.server.active_requests` | Asynchronous UpDownCounter | {requests} | measures the number of concurrent HTTP requests that are currently in-flight |
20+
| Name | Instrument | Unit | Unit (UCUM) | Description |
21+
|-------------------------------|----------------------------|--------------|--------------|-------------|
22+
| `http.server.duration` | Histogram | milliseconds | `ms` | measures the duration of the inbound HTTP request |
23+
| `http.server.active_requests` | Asynchronous UpDownCounter | requests | `{requests}` | measures the number of concurrent HTTP requests that are currently in-flight |
2424

2525
### HTTP Client
2626

2727
Below is a table of HTTP client metric instruments.
2828

29-
| Name | Instrument | Units | Description |
30-
|------------------------|------------|-------|-------------|
31-
| `http.client.duration` | Histogram | ms | measure the duration of the outbound HTTP request in milliseconds |
29+
| Name | Instrument | Unit | Unit (UCUM) | Description |
30+
|------------------------|------------|--------------|-------------|-------------|
31+
| `http.client.duration` | Histogram | milliseconds | `ms` | measure the duration of the outbound HTTP request |
3232

3333
## Attributes
3434

‎specification/metrics/semantic_conventions/rpc.md

+14-14
Original file line numberDiff line numberDiff line change
@@ -31,26 +31,26 @@ MUST be of the specified type and units.
3131

3232
Below is a table of RPC server metric instruments.
3333

34-
| Name | Instrument | Units | Description | Status | Streaming |
35-
|------|------------|-------|-------------|--------|-----------|
36-
| `rpc.server.duration` | Histogram | ms | measures duration of inbound RPC in milliseconds | Recommended | N/A. While streaming RPCs may record this metric as start-of-batch to end-of-batch, it's hard to interpret in practice. |
37-
| `rpc.server.request.size` | Histogram | By | measures size of RPC request messages in bytes (uncompressed) | Optional | Recorded per message in a streaming batch |
38-
| `rpc.server.response.size` | Histogram | By | measures size of RPC response messages in bytes (uncompressed) | Optional | Recorded per response in a streaming batch |
39-
| `rpc.server.requests_per_rpc` | Histogram | {count} | measures the number of messages received per RPC. Should be 1 for all non-streaming RPCs | Optional | Required |
40-
| `rpc.server.responses_per_rpc` | Histogram | {count} | measures the number of messages sent per RPC. Should be 1 for all non-streaming RPCs | Optional | Required |
34+
| Name | Instrument | Unit | Unit (UCUM) | Description | Status | Streaming |
35+
|------|------------|------|-------------|-------------|--------|-----------|
36+
| `rpc.server.duration` | Histogram | Bytes | `ms` | measures duration of inbound RPC | Recommended | N/A. While streaming RPCs may record this metric as start-of-batch to end-of-batch, it's hard to interpret in practice. |
37+
| `rpc.server.request.size` | Histogram | Bytes | `By` | measures size of RPC request messages (uncompressed) | Optional | Recorded per message in a streaming batch |
38+
| `rpc.server.response.size` | Histogram | Bytes | `By` | measures size of RPC response messages (uncompressed) | Optional | Recorded per response in a streaming batch |
39+
| `rpc.server.requests_per_rpc` | Histogram | count | `{count}` | measures the number of messages received per RPC. Should be 1 for all non-streaming RPCs | Optional | Required |
40+
| `rpc.server.responses_per_rpc` | Histogram | count | `{count}` | measures the number of messages sent per RPC. Should be 1 for all non-streaming RPCs | Optional | Required |
4141

4242
### RPC Client
4343

4444
Below is a table of RPC client metric instruments. These apply to traditional
4545
RPC usage, not streaming RPCs.
4646

47-
| Name | Instrument | Units | Description | Status | Streaming |
48-
|------|------------|-------|-------------|--------|-----------|
49-
| `rpc.client.duration` | Histogram | ms | measures duration of outbound RPC in milliseconds | Recommended | N/A. While streaming RPCs may record this metric as start-of-batch to end-of-batch, it's hard to interpret in practice. |
50-
| `rpc.client.request.size` | Histogram | By | measures size of RPC request messages in bytes (uncompressed) | Optional | Recorded per message in a streaming batch |
51-
| `rpc.client.response.size` | Histogram | By | measures size of RPC response messages in bytes (uncompressed) | Optional | Recorded per message in a streaming batch |
52-
| `rpc.client.requests_per_rpc` | Histogram | {count} | measures the number of messages received per RPC. Should be 1 for all non-streaming RPCs | Optional | Required |
53-
| `rpc.client.responses_per_rpc` | Histogram | {count} | measures the number of messages sent per RPC. Should be 1 for all non-streaming RPCs | Optional | Required |
47+
| Name | Instrument | Unit | Unit (UCUM) | Description | Status | Streaming |
48+
|------|------------|------|-------------|-------------|--------|-----------|
49+
| `rpc.client.duration` | Histogram | milliseconds | `ms` | measures duration of outbound RPC | Recommended | N/A. While streaming RPCs may record this metric as start-of-batch to end-of-batch, it's hard to interpret in practice. |
50+
| `rpc.client.request.size` | Histogram | Bytes | `By` | measures size of RPC request messages (uncompressed) | Optional | Recorded per message in a streaming batch |
51+
| `rpc.client.response.size` | Histogram | Bytes | `By` | measures size of RPC response messages (uncompressed) | Optional | Recorded per message in a streaming batch |
52+
| `rpc.client.requests_per_rpc` | Histogram | count | `{count}` | measures the number of messages received per RPC. Should be 1 for all non-streaming RPCs | Optional | Required |
53+
| `rpc.client.responses_per_rpc` | Histogram | count | `{count}` | measures the number of messages sent per RPC. Should be 1 for all non-streaming RPCs | Optional | Required |
5454

5555
## Attributes
5656

0 commit comments

Comments
 (0)