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.

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

[chore] Mark attributes and metrics as experimental explicitly #781

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions model/faas-common.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,10 @@ groups:
- id: other
value: 'other'
brief: 'If none of the others apply'
stability: experimental
- id: invoked_name
type: string
stability: experimental
requirement_level: required
brief: >
The name of the invoked function.
Expand All @@ -52,6 +54,7 @@ groups:
- id: 'tencent_cloud'
value: 'tencent_cloud'
brief: 'Tencent Cloud'
stability: experimental
requirement_level: required
brief: >
The cloud provider of the invoked function.
Expand All @@ -60,6 +63,7 @@ groups:
invoked function.
- id: invoked_region
type: string
stability: experimental
requirement_level:
conditionally_required: >
For some cloud providers, like AWS or GCP, the region in which a
Expand Down
4 changes: 4 additions & 0 deletions model/general.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ groups:
attributes:
- id: service
type: string
stability: experimental
brief: >
The [`service.name`](/docs/resource/README.md#service)
of the remote service. SHOULD be equal to the actual `service.name`
Expand All @@ -47,17 +48,20 @@ groups:
attributes:
- id: id
type: string
stability: experimental
brief: >
Username or client_id extracted from the access token or
[Authorization](https://tools.ietf.org/html/rfc7235#section-4.2)
header in the inbound request from outside the system.
examples: 'username'
- id: role
type: string
stability: experimental
brief: 'Actual/assumed role the client is making the request under extracted from token or application security context.'
examples: 'admin'
- id: scope
type: string
stability: experimental
brief: >
Scopes or granted authorities the client currently possesses extracted from token
or application security context. The value would come from the scope associated
Expand Down
1 change: 1 addition & 0 deletions model/logs/events.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ groups:
attributes:
- id: name
type: string
stability: experimental
requirement_level: required
brief: >
Identifies the class / type of event.
Expand Down
1 change: 1 addition & 0 deletions model/logs/general.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ groups:
attributes:
- id: uid
type: string
stability: experimental
requirement_level: opt_in
brief: >
A unique identifier for the Log Record.
Expand Down
5 changes: 5 additions & 0 deletions model/logs/media.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ groups:
attributes:
- id: iostream
requirement_level: opt_in
stability: experimental
brief: >
The stream associated with the log. See below for a list of well-known values.
type:
Expand All @@ -25,24 +26,28 @@ groups:
attributes:
- id: name
type: string
stability: experimental
requirement_level: recommended
brief: >
The basename of the file.
examples: ["audit.log"]
- id: path
type: string
stability: experimental
requirement_level: opt_in
brief: >
The full path to the file.
examples: [ "/var/log/mysql/audit.log" ]
- id: name_resolved
type: string
stability: experimental
requirement_level: opt_in
brief: >
The basename of the file, with symlinks resolved.
examples: [ "uuid.log" ]
- id: path_resolved
type: string
stability: experimental
requirement_level: opt_in
brief: >
The full path to the file, with symlinks resolved.
Expand Down
2 changes: 2 additions & 0 deletions model/logs/mobile-events.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ groups:
This event represents an occurrence of a lifecycle transition on the iOS platform.
attributes:
- id: state
stability: experimental
requirement_level: "required"
note: >
The iOS lifecycle states are defined in the [UIApplicationDelegate documentation](https://developer.apple.com/documentation/uikit/uiapplicationdelegate#1656902),
Expand Down Expand Up @@ -46,6 +47,7 @@ groups:
This event represents an occurrence of a lifecycle transition on the Android platform.
attributes:
- id: state
stability: experimental
requirement_level: required
brief: >
This attribute represents the state the application has transitioned into at the occurrence of the event.
Expand Down
11 changes: 11 additions & 0 deletions model/metrics/database-metrics.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ groups:
brief: Describes Database attributes
attributes:
- id: state
stability: experimental
type:
allow_custom_values: false
members:
Expand All @@ -16,6 +17,7 @@ groups:
examples: ["idle"]
- id: pool.name
type: string
stability: experimental
requirement_level: required
brief: >
The name of the connection pool; unique within the instrumented application.
Expand All @@ -27,6 +29,7 @@ groups:
- id: metric.db.client.connections.usage
type: metric
metric_name: db.client.connections.usage
stability: experimental
brief: "The number of connections that are currently in state described by the `state` attribute"
instrument: updowncounter
unit: "{connection}"
Expand All @@ -37,6 +40,7 @@ groups:
- id: metric.db.client.connections.idle.max
type: metric
metric_name: db.client.connections.idle.max
stability: experimental
brief: "The maximum number of idle open connections allowed"
instrument: updowncounter
unit: "{connection}"
Expand All @@ -46,6 +50,7 @@ groups:
- id: metric.db.client.connections.idle.min
type: metric
metric_name: db.client.connections.idle.min
stability: experimental
brief: "The minimum number of idle open connections allowed"
instrument: updowncounter
unit: "{connection}"
Expand All @@ -55,6 +60,7 @@ groups:
- id: metric.db.client.connections.max
type: metric
metric_name: db.client.connections.max
stability: experimental
brief: "The maximum number of open connections allowed"
instrument: updowncounter
unit: "{connection}"
Expand All @@ -64,6 +70,7 @@ groups:
- id: metric.db.client.connections.pending_requests
type: metric
metric_name: db.client.connections.pending_requests
stability: experimental
brief: "The number of pending requests for an open connection, cumulative for the entire pool"
instrument: updowncounter
unit: "{request}"
Expand All @@ -73,6 +80,7 @@ groups:
- id: metric.db.client.connections.timeouts
type: metric
metric_name: db.client.connections.timeouts
stability: experimental
brief: "The number of connection timeouts that have occurred trying to obtain a connection from the pool"
instrument: counter
unit: "{timeout}"
Expand All @@ -82,6 +90,7 @@ groups:
- id: metric.db.client.connections.create_time
type: metric
metric_name: db.client.connections.create_time
stability: experimental
brief: "The time it took to create a new connection"
instrument: histogram
unit: "ms"
Expand All @@ -91,6 +100,7 @@ groups:
- id: metric.db.client.connections.wait_time
type: metric
metric_name: db.client.connections.wait_time
stability: experimental
brief: "The time it took to obtain an open connection from the pool"
instrument: histogram
unit: "ms"
Expand All @@ -100,6 +110,7 @@ groups:
- id: metric.db.client.connections.use_time
type: metric
metric_name: db.client.connections.use_time
stability: experimental
brief: "The time between borrowing a connection and returning it to the pool"
instrument: histogram
unit: "ms"
Expand Down
9 changes: 9 additions & 0 deletions model/metrics/faas-metrics.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ groups:
- id: metric.faas.invoke_duration
type: metric
metric_name: faas.invoke_duration
stability: experimental
brief: "Measures the duration of the function's logic execution"
instrument: histogram
unit: "s"
Expand All @@ -11,6 +12,7 @@ groups:
- id: metric.faas.init_duration
type: metric
metric_name: faas.init_duration
stability: experimental
brief: "Measures the duration of the function's initialization, such as a cold start"
instrument: histogram
unit: "s"
Expand All @@ -20,6 +22,7 @@ groups:
- id: metric.faas.coldstarts
type: metric
metric_name: faas.coldstarts
stability: experimental
brief: "Number of invocation cold starts"
instrument: counter
unit: "{coldstart}"
Expand All @@ -29,6 +32,7 @@ groups:
- id: metric.faas.errors
type: metric
metric_name: faas.errors
stability: experimental
brief: "Number of invocation errors"
instrument: counter
unit: "{error}"
Expand All @@ -38,6 +42,7 @@ groups:
- id: metric.faas.invocations
type: metric
metric_name: faas.invocations
stability: experimental
brief: "Number of successful invocations"
instrument: counter
unit: "{invocation}"
Expand All @@ -47,6 +52,7 @@ groups:
- id: metric.faas.timeouts
type: metric
metric_name: faas.timeouts
stability: experimental
brief: "Number of invocation timeouts"
instrument: counter
unit: "{timeout}"
Expand All @@ -56,6 +62,7 @@ groups:
- id: metric.faas.mem_usage
type: metric
metric_name: faas.mem_usage
stability: experimental
brief: "Distribution of max memory usage per invocation"
instrument: histogram
unit: "By"
Expand All @@ -65,6 +72,7 @@ groups:
- id: metric.faas.cpu_usage
type: metric
metric_name: faas.cpu_usage
stability: experimental
brief: "Distribution of CPU usage per invocation"
instrument: histogram
unit: "s"
Expand All @@ -74,6 +82,7 @@ groups:
- id: metric.faas.net_io
type: metric
metric_name: faas.net_io
stability: experimental
brief: "Distribution of net I/O usage per invocation"
instrument: histogram
unit: "By"
Expand Down
5 changes: 5 additions & 0 deletions model/metrics/http.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ groups:
- id: metric.http.server.active_requests
type: metric
metric_name: http.server.active_requests
stability: experimental
brief: "Number of active HTTP server requests."
instrument: updowncounter
unit: "{request}"
Expand Down Expand Up @@ -66,6 +67,7 @@ groups:
- id: metric.http.server.request.body.size
type: metric
metric_name: http.server.request.body.size
stability: experimental
brief: "Size of HTTP server request bodies."
instrument: histogram
unit: "By"
Expand All @@ -78,6 +80,7 @@ groups:
- id: metric.http.server.response.body.size
type: metric
metric_name: http.server.response.body.size
stability: experimental
brief: "Size of HTTP server response bodies."
instrument: histogram
unit: "By"
Expand All @@ -99,6 +102,7 @@ groups:
- id: metric.http.client.request.body.size
type: metric
metric_name: http.client.request.body.size
stability: experimental
brief: "Size of HTTP client request bodies."
instrument: histogram
unit: "By"
Expand All @@ -111,6 +115,7 @@ groups:
- id: metric.http.client.response.body.size
type: metric
metric_name: http.client.response.body.size
stability: experimental
brief: "Size of HTTP client response bodies."
instrument: histogram
unit: "By"
Expand Down
7 changes: 7 additions & 0 deletions model/metrics/jvm-metrics-experimental.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ groups:
- id: metric.jvm.memory.init
type: metric
metric_name: jvm.memory.init
stability: experimental
extends: attributes.jvm.memory
brief: "Measure of initial memory requested."
instrument: updowncounter
Expand All @@ -10,6 +11,7 @@ groups:
- id: metric.jvm.system.cpu.utilization
type: metric
metric_name: jvm.system.cpu.utilization
stability: experimental
brief: "Recent CPU utilization for the whole system as reported by the JVM."
note: >
The value range is [0.0,1.0].
Expand All @@ -22,6 +24,7 @@ groups:
- id: metric.jvm.system.cpu.load_1m
type: metric
metric_name: jvm.system.cpu.load_1m
stability: experimental
brief: "Average CPU load of the whole system for the last minute as reported by the JVM."
note: >
The value range is [0,n], where n is the number of CPU cores - or a negative number if the value is not available.
Expand All @@ -38,6 +41,7 @@ groups:
attributes:
- id: pool.name
type: string
stability: experimental
requirement_level: recommended
brief: Name of the buffer pool.
examples: [ "mapped", "direct" ]
Expand All @@ -48,6 +52,7 @@ groups:
- id: metric.jvm.buffer.memory.usage
type: metric
metric_name: jvm.buffer.memory.usage
stability: experimental
extends: attributes.jvm.buffer
brief: "Measure of memory used by buffers."
instrument: updowncounter
Expand All @@ -56,6 +61,7 @@ groups:
- id: metric.jvm.buffer.memory.limit
type: metric
metric_name: jvm.buffer.memory.limit
stability: experimental
extends: attributes.jvm.buffer
brief: "Measure of total memory capacity of buffers."
instrument: updowncounter
Expand All @@ -64,6 +70,7 @@ groups:
- id: metric.jvm.buffer.count
type: metric
metric_name: jvm.buffer.count
stability: experimental
extends: attributes.jvm.buffer
brief: "Number of buffers in the pool."
instrument: updowncounter
Expand Down
Loading
Loading