use yaml to generate the file

open-telemetry · Jan 4, 2023 · 6f2ec5e · 6f2ec5e
1 parent a02abaa
commit 6f2ec5e
Show file tree

Hide file tree

Showing 2 changed files with 47 additions and 11 deletions.
diff --git a/semantic_conventions/resource/heroku.yaml b/semantic_conventions/resource/heroku.yaml
@@ -0,0 +1,37 @@
+groups:
+  - id: heroku
+    prefix: heroku
+    type: resource
+    brief: >
+      Heroku dyno metadata
+    attributes:
+      - id: release.version
+        type: string
+        brief: >
+          Identifier for the current release
+        examples: ['v42']
+      - id: release.creation_timestamp
+        type: string
+        brief: >
+          Time and date the release was created
+        examples: [ '2022-10-23T18:00:42Z' ]
+      - id: heroku.release.commit
+        type: string
+        brief: >
+          Commit hash for the current release
+        examples: [ 'e6134959463efd8966b20e75b913cafe3f5ec' ]
+      - id: heroku.app.name
+        type: string
+        brief: >
+          Application name
+        examples: [ 'foo-app' ]
+      - id: heroku.app.id
+        type: string
+        brief: >
+          Unique identifier for the application
+        examples: [ '2daa2797-e42b-4624-9322-ec3f968df4da' ]
+      - id: heroku.dyno.id
+        type: string
+        brief: >
+          Dyno identifier. Used as host name
+        examples: [ '2vac3221-f56c-1897-4453-ba4d8638c1ac' ]
diff --git a/specification/resource/semantic_conventions/heroku.md b/specification/resource/semantic_conventions/heroku.md
@@ -6,14 +6,13 @@
 
 **Description:** Heroku dyno metadata [1]
 
-<!-- semconv cloud -->
-| Attribute                         | Type   | Description                           | Examples                                | Requirement Level |
-|-----------------------------------|--------|---------------------------------------|-----------------------------------------|-------------------|
-| heroku.release.version            | string | Identifier for the current release    | `v42`                                   | Recommended       |
-| heroku.release.creation_timestamp | string | Time and date the release was created | `2022-10-23T18:00:42Z`                  | Recommended       |
-| heroku.release.commit             | string | Commit hash for the current release   | `e6134959463efd8966b20e75b913cafe3f5ec` | Recommended       |
-| heroku.app.name                   | string | Application name                      | `foo-app`                               | Recommended       |
-| heroku.app.id                     | string | Unique identifier for the application | `2daa2797-e42b-4624-9322-ec3f968df4da`  | Recommended       |
-| heroku.dyno.id                    | string | Dyno identifier. Used as host name    | `2vac3221-f56c-1897-4453-ba4d8638c1ac`  | Recommended       |
-
-[1]: https://devcenter.heroku.com/articles/dyno-metadata
+<!-- semconv heroku -->
+| Attribute  | Type | Description  | Examples  | Requirement Level |
+|---|---|---|---|---|
+| `heroku.release.version` | string | Identifier for the current release | `v42` | Recommended |
+| `heroku.release.creation_timestamp` | string | Time and date the release was created | `2022-10-23T18:00:42Z` | Recommended |
+| `heroku.heroku.release.commit` | string | Commit hash for the current release | `e6134959463efd8966b20e75b913cafe3f5ec` | Recommended |
+| `heroku.heroku.app.name` | string | Application name | `foo-app` | Recommended |
+| `heroku.heroku.app.id` | string | Unique identifier for the application | `2daa2797-e42b-4624-9322-ec3f968df4da` | Recommended |
+| `heroku.heroku.dyno.id` | string | Dyno identifier. Used as host name | `2vac3221-f56c-1897-4453-ba4d8638c1ac` | Recommended |
+<!-- endsemconv -->