Skip to content

Commit

Permalink
Add missing stability levels to spans, resources and events
Browse files Browse the repository at this point in the history
  • Loading branch information
lmolkova committed Dec 5, 2024
1 parent 106f880 commit fc21a57
Show file tree
Hide file tree
Showing 29 changed files with 69 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"MD040": false,
},
"yaml.schemas": {
"https://raw.githubusercontent.com/open-telemetry/weaver/v0.9.2/schemas/semconv.schema.json": [
"https://raw.githubusercontent.com/open-telemetry/weaver/v0.11.0/schemas/semconv.schema.json": [
"model/**/*.yaml"
]
},
Expand Down
2 changes: 1 addition & 1 deletion dependencies.Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# Dependabot can keep this file up to date with latest containers.

# Weaver is used to generate markdown docs, and enforce policies on the model.
FROM otel/weaver:v0.10.0 AS weaver
FROM otel/weaver:v0.11.0 AS weaver

# OPA is used to test policies enforced by weaver.
FROM openpolicyagent/opa:0.70.0 AS opa
Expand Down
1 change: 1 addition & 0 deletions model/android/resources.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
groups:
- id: resource.android
type: resource
stability: experimental
name: android
brief: >
The Android platform on which the Android application is running.
Expand Down
1 change: 1 addition & 0 deletions model/aws/ecs-resources.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
groups:
- id: resource.aws.ecs
type: resource
stability: experimental
name: aws.ecs
brief: >
Resources used by AWS Elastic Container Service (ECS).
Expand Down
1 change: 1 addition & 0 deletions model/aws/eks-resources.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
groups:
- id: resource.aws.eks
type: resource
stability: experimental
name: aws.eks
brief: >
Resources used by AWS Elastic Kubernetes Service (EKS).
Expand Down
1 change: 1 addition & 0 deletions model/aws/lambda-spans.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
groups:
- id: span.aws.lambda
type: span
stability: experimental
brief: >
Span attributes used by AWS Lambda (in addition to general `faas` attributes).
attributes:
Expand Down
1 change: 1 addition & 0 deletions model/aws/logs-resources.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
groups:
- id: resource.aws.log
type: resource
stability: experimental
name: aws.log
brief: >
Resources specific to Amazon Web Services.
Expand Down
15 changes: 15 additions & 0 deletions model/aws/sdk-spans.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
groups:
- id: span.aws.client
type: span
stability: experimental
span_kind: client
brief: >
The `aws` conventions apply to operations using the AWS SDK. They map request or response parameters
Expand Down Expand Up @@ -32,6 +33,7 @@ groups:
- id: span.dynamodb.batchgetitem.client
brief: DynamoDB.BatchGetItem
extends: span.aws.client
stability: experimental
type: span
span_kind: client
attributes:
Expand All @@ -44,6 +46,7 @@ groups:
brief: DynamoDB.BatchWriteItem
extends: span.aws.client
type: span
stability: experimental
span_kind: client
attributes:
- ref: aws.dynamodb.table_names
Expand All @@ -57,6 +60,7 @@ groups:
brief: DynamoDB.CreateTable
extends: span.aws.client
type: span
stability: experimental
span_kind: client
attributes:
- ref: aws.dynamodb.global_secondary_indexes
Expand All @@ -81,6 +85,7 @@ groups:
brief: DynamoDB.DeleteItem
extends: span.aws.client
type: span
stability: experimental
span_kind: client
attributes:
- ref: aws.dynamodb.table_names
Expand All @@ -97,6 +102,7 @@ groups:
brief: DynamoDB.DeleteTable
extends: span.aws.client
type: span
stability: experimental
span_kind: client
attributes:
- ref: aws.dynamodb.table_names
Expand All @@ -109,6 +115,7 @@ groups:
brief: DynamoDB.DescribeTable
extends: span.aws.client
type: span
stability: experimental
span_kind: client
attributes:
- ref: aws.dynamodb.table_names
Expand All @@ -121,6 +128,7 @@ groups:
brief: DynamoDB.GetItem
extends: span.aws.client
type: span
stability: experimental
span_kind: client
attributes:
- ref: aws.dynamodb.table_names
Expand All @@ -139,6 +147,7 @@ groups:
brief: DynamoDB.ListTables
extends: span.aws.client
type: span
stability: experimental
span_kind: client
attributes:
- ref: aws.dynamodb.exclusive_start_table
Expand All @@ -152,6 +161,7 @@ groups:
brief: DynamoDB.PutItem
extends: span.aws.client
type: span
stability: experimental
span_kind: client
attributes:
- ref: aws.dynamodb.table_names
Expand All @@ -165,6 +175,7 @@ groups:
brief: DynamoDB.Query
extends: span.aws.client
type: span
stability: experimental
span_kind: client
attributes:
- ref: aws.dynamodb.scan_forward
Expand Down Expand Up @@ -193,6 +204,7 @@ groups:
brief: DynamoDB.Scan
extends: span.aws.client
type: span
stability: experimental
span_kind: client
attributes:
- ref: aws.dynamodb.segment
Expand Down Expand Up @@ -228,6 +240,7 @@ groups:
extends: span.aws.client
type: span
span_kind: client
stability: experimental
attributes:
- ref: aws.dynamodb.table_names
requirement_level: recommended
Expand All @@ -243,6 +256,7 @@ groups:
brief: DynamoDB.UpdateTable
extends: span.aws.client
type: span
stability: experimental
span_kind: client
attributes:
- ref: aws.dynamodb.attribute_definitions
Expand All @@ -264,6 +278,7 @@ groups:
- id: span.aws.s3.client
extends: span.aws.client
type: span
stability: experimental
span_kind: client
brief: "Attributes that exist for S3 request types."
attributes:
Expand Down
1 change: 1 addition & 0 deletions model/browser/resources.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
groups:
- id: resource.browser
type: resource
stability: experimental
name: browser
brief: >
The web browser in which the application represented by the resource is running.
Expand Down
1 change: 1 addition & 0 deletions model/cloud/resources.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
groups:
- id: resource.cloud
type: resource
stability: experimental
name: cloud
brief: >
A cloud environment (e.g. GCP, Azure, AWS)
Expand Down
5 changes: 5 additions & 0 deletions model/cloudfoundry/resources.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
groups:
- id: resource.cloudfoundry.system
type: resource
stability: experimental
name: cloudfoundry.system
brief: >
The system component which is monitored.
Expand All @@ -9,6 +10,7 @@ groups:
- ref: cloudfoundry.system.instance.id
- id: resource.cloudfoundry.app
type: resource
stability: experimental
name: cloudfoundry.app
brief: >
The application which is monitored.
Expand All @@ -17,6 +19,7 @@ groups:
- ref: cloudfoundry.app.name
- id: resource.cloudfoundry.space
type: resource
stability: experimental
name: cloudfoundry.space
brief: >
The space of the application which is monitored.
Expand All @@ -25,6 +28,7 @@ groups:
- ref: cloudfoundry.space.name
- id: resource.cloudfoundry.org
type: resource
stability: experimental
name: cloudfoundry.org
brief: >
The organization of the application which is monitored.
Expand All @@ -33,6 +37,7 @@ groups:
- ref: cloudfoundry.org.name
- id: resource.cloudfoundry.process
type: resource
stability: experimental
name: cloudfoundry.process
brief: >
The process of the application which is monitored.
Expand Down
1 change: 1 addition & 0 deletions model/container/resources.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
groups:
- id: resource.container
type: resource
stability: experimental
name: container
brief: >
A container instance.
Expand Down
3 changes: 3 additions & 0 deletions model/database/spans.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,7 @@ groups:

- id: span.db.postgresql.client
type: span
stability: experimental
extends: span.db.sql.client
span_kind: client
brief: >
Expand Down Expand Up @@ -186,6 +187,7 @@ groups:

- id: span.db.mysql.client
type: span
stability: experimental
extends: span.db.sql.client
span_kind: client
brief: >
Expand All @@ -212,6 +214,7 @@ groups:

- id: span.db.mariadb.client
type: span
stability: experimental
extends: span.db.sql.client
span_kind: client
brief: >
Expand Down
1 change: 1 addition & 0 deletions model/deployment/resources.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
groups:
- id: resource.deployment
type: resource
stability: experimental
name: deployment
brief: >
The software deployment.
Expand Down
1 change: 1 addition & 0 deletions model/device/resources.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
groups:
- id: resource.device
type: resource
stability: experimental
name: device
brief: >
The device on which the process represented by this resource is running.
Expand Down
1 change: 1 addition & 0 deletions model/faas/resources.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
groups:
- id: resource.faas
type: resource
stability: experimental
name: faas
brief: >
A serverless instance.
Expand Down
5 changes: 5 additions & 0 deletions model/faas/spans.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
groups:
- id: span.faas
type: span
stability: experimental
brief: >
This semantic convention describes an instance of a function that
runs without provisioning or managing of servers (also known as
Expand All @@ -22,6 +23,7 @@ groups:

- id: span.faas.datasource
type: span
stability: experimental
brief: >
Semantic Convention for FaaS triggered as a response to some data
source operation such as a database or filesystem read/write.
Expand All @@ -35,6 +37,7 @@ groups:

- id: span.faas.timer
type: span
stability: experimental
brief: >
Semantic Convention for FaaS scheduled to be executed regularly.
attributes:
Expand All @@ -44,6 +47,7 @@ groups:
- id: span.faas.server
span_kind: server
type: span
stability: experimental
brief: >
Contains additional attributes for incoming FaaS spans.
attributes:
Expand All @@ -64,6 +68,7 @@ groups:
- id: span.faas.client
span_kind: client
type: span
stability: experimental
brief: >
Contains additional attributes for outgoing FaaS spans.
attributes:
Expand Down
1 change: 1 addition & 0 deletions model/feature-flags/logs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ groups:
- id: event.feature_flag.evaluation
type: event
name: feature_flag.evaluation
stability: experimental
brief: >
Defines feature flag evaluation as an event.
note: >
Expand Down
1 change: 1 addition & 0 deletions model/gcp/cloud-run-resources.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
groups:
- id: resource.gcp.cloud_run
type: resource
stability: experimental
name: gcp.cloud_run
brief: >
Resource used by Google Cloud Run.
Expand Down
1 change: 1 addition & 0 deletions model/gcp/gce-resources.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
groups:
- id: resource.gcp.gce
type: resource
stability: experimental
name: gcp.gce
brief: >
Resources used by Google Compute Engine (GCE).
Expand Down
1 change: 1 addition & 0 deletions model/graphql/spans.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
groups:
- id: span.graphql.server
type: span
stability: experimental
span_kind: server
brief: >
This document defines semantic conventions to apply when instrumenting the GraphQL implementation. They map
Expand Down
1 change: 1 addition & 0 deletions model/heroku/resources.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
groups:
- id: resource.heroku
type: resource
stability: experimental
name: heroku
brief: >
[Heroku dyno metadata](https://devcenter.heroku.com/articles/dyno-metadata)
Expand Down
2 changes: 2 additions & 0 deletions model/host/resources.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
groups:
- id: resource.host
type: resource
stability: experimental
name: host
brief: >
A host is defined as a computing instance. For example, physical servers, virtual machines, switches or disk array.
Expand Down Expand Up @@ -45,6 +46,7 @@ groups:

- id: resource.host.cpu
type: resource
stability: experimental
name: host.cpu
brief: >
A host's CPU information
Expand Down
Loading

0 comments on commit fc21a57

Please sign in to comment.