-
Notifications
You must be signed in to change notification settings - Fork 367
Add GCP AppHub resource labels #2006
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
Merged
Merged
Changes from 6 commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
af23b0f
Add link to apphub resources.
jsuereth 1d4e45c
Add changelog.
jsuereth d30f6b1
Fix markdownlint issues.
jsuereth c136b42
Fix yaml lint.
jsuereth 5e5eb01
Fix typo.
jsuereth 796ecd8
Regenerate tables.
jsuereth 9dd00f8
Update docs/resource/cloud-provider/gcp/apphub.md
jsuereth 1e936a4
Fix descriptions as per review.
jsuereth 893920b
Migrate criticality and environment to enums.
jsuereth f4877d2
Fix yamllint issue.
jsuereth af4ace1
Update model/gcp/registry.yaml
jsuereth b61f76c
Update model/gcp/registry.yaml
jsuereth 78c06a4
Regenerate markdown.
jsuereth 6e39870
Merge branch 'main' into wip-gcp-apphub
jsuereth File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| # Use this changelog template to create an entry for release notes. | ||
| # | ||
| # If your change doesn't affect end users you should instead start | ||
| # your pull request title with [chore] or use the "Skip Changelog" label. | ||
|
|
||
| # One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' | ||
| change_type: enhancement | ||
|
|
||
| # The name of the area of concern in the attributes-registry, (e.g. http, cloud, db) | ||
| component: gcp | ||
|
|
||
| # A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). | ||
| note: Adds GCP AppHub labels for resource. | ||
|
|
||
| # Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists. | ||
| # The values here must be integers. | ||
| issues: [2006] | ||
|
|
||
| # (Optional) One or more lines of additional information to render under the primary note. | ||
| # These lines will be padded with 2 spaces and then inserted directly into the document. | ||
| # Use pipe (|) for multiline entries. | ||
| subtext: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,102 @@ | ||
| # Google Cloud AppHub | ||
|
|
||
| **Status**: [Development][DocumentStatus] | ||
|
|
||
| These conventions are used by Google Cloud when using AppHub. Observability | ||
| data from Google Cloud will be annotated with these resource types, depending | ||
| on the source of telemetry. For example, metrics coming from a Google Cloud | ||
| service will be annotated with the appropriate `gcp.apphub.application` and | ||
| `gcp.apphub.service` as configured in AppHub. | ||
|
|
||
| See [Supported Resources](https://cloud.google.com/app-hub/docs/supported-resources) for what data will be annotated by Google Cloud. | ||
|
|
||
| ## Application | ||
|
|
||
| <!-- semconv resource.gcp.apphub.application --> | ||
| <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. --> | ||
| <!-- see templates/registry/markdown/snippet.md.j2 --> | ||
| <!-- prettier-ignore-start --> | ||
| <!-- markdownlint-capture --> | ||
| <!-- markdownlint-disable --> | ||
|
|
||
|
|
||
| **Status:**  | ||
|
|
||
| **type:** `gcp.apphub.application` | ||
|
|
||
| **Description:** Attributes denoting data from an Application in AppHub. See [AppHub overview](https://cloud.google.com/app-hub/docs/overview). | ||
|
|
||
| | Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability | | ||
| |---|---|---|---|---|---| | ||
| | [`gcp.apphub.application.container`](/docs/attributes-registry/gcp.md) | string | The container within GCP where the AppHub application is defined. | `projects/my-container-project` | `Required` |  | | ||
| | [`gcp.apphub.application.id`](/docs/attributes-registry/gcp.md) | string | The name of the application as configured in AppHub. | `my-application` | `Required` |  | | ||
| | [`gcp.apphub.application.location`](/docs/attributes-registry/gcp.md) | string | The GCP zone or region where the application is defined. | `us-central1` | `Required` |  | | ||
|
|
||
| <!-- markdownlint-restore --> | ||
| <!-- prettier-ignore-end --> | ||
| <!-- END AUTOGENERATED TEXT --> | ||
| <!-- endsemconv --> | ||
|
|
||
| ## Service | ||
|
|
||
| <!-- semconv resource.gcp.apphub.service --> | ||
| <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. --> | ||
| <!-- see templates/registry/markdown/snippet.md.j2 --> | ||
| <!-- prettier-ignore-start --> | ||
| <!-- markdownlint-capture --> | ||
| <!-- markdownlint-disable --> | ||
|
|
||
|
|
||
| **Status:**  | ||
|
|
||
| **type:** `gcp.apphub.service` | ||
|
|
||
| **Description:** Attributes denoting data from a Service in AppHub. See [AppHub overview](https://cloud.google.com/app-hub/docs/overview). | ||
|
|
||
| | Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability | | ||
| |---|---|---|---|---|---| | ||
| | [`gcp.apphub.service.criticality_type`](/docs/attributes-registry/gcp.md) | string | Criticality of an application, service, or workload indicates its importance to the business. [1] | `CRITICAL`; `HIGH`; `MEDIUM`; `LOW` | `Required` |  | | ||
| | [`gcp.apphub.service.environment_type`](/docs/attributes-registry/gcp.md) | string | Environment of an application, service, or workload is the stage of a software lifecycle, for example, production, staging, or development. [2] | `DEVELOPMENT`; `TEST`; `STAGING`; `PRODUCTION` | `Required` |  | | ||
| | [`gcp.apphub.service.id`](/docs/attributes-registry/gcp.md) | string | The name of the service as configured in AppHub. | `my-service` | `Required` |  | | ||
|
|
||
| **[1] `gcp.apphub.service.criticality_type`:** [See AppHub properties and attributes](https://cloud.google.com/app-hub/docs/overview#properties-attributes) | ||
|
|
||
| **[2] `gcp.apphub.service.environment_type`:** [See AppHub properties and attributes](https://cloud.google.com/app-hub/docs/overview#properties-attributes) | ||
|
|
||
| <!-- markdownlint-restore --> | ||
| <!-- prettier-ignore-end --> | ||
| <!-- END AUTOGENERATED TEXT --> | ||
| <!-- endsemconv --> | ||
|
|
||
| ## Workload | ||
|
|
||
| <!-- semconv resource.gcp.apphub.workload --> | ||
| <!-- NOTE: THIS TEXT IS AUTOGENERATED. DO NOT EDIT BY HAND. --> | ||
| <!-- see templates/registry/markdown/snippet.md.j2 --> | ||
| <!-- prettier-ignore-start --> | ||
| <!-- markdownlint-capture --> | ||
| <!-- markdownlint-disable --> | ||
|
|
||
|
|
||
| **Status:**  | ||
|
|
||
| **type:** `gcp.apphub.workload` | ||
|
|
||
| **Description:** Attributes denoting data from a Workload in AppHub. See [AppHub overview](https://cloud.google.com/app-hub/docs/overview). | ||
|
|
||
| | Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability | | ||
| |---|---|---|---|---|---| | ||
| | [`gcp.apphub.workload.criticality_type`](/docs/attributes-registry/gcp.md) | string | Criticality of an application, service, or workload indicates its importance to the business. [1] | `CRITICAL`; `HIGH`; `MEDIUM`; `LOW` | `Required` |  | | ||
| | [`gcp.apphub.workload.environment_type`](/docs/attributes-registry/gcp.md) | string | Environment of an application, service, or workload is the stage of a software lifecycle, for example, production, staging, or development. [2] | `DEVELOPMENT`; `TEST`; `STAGING`; `PRODUCTION` | `Required` |  | | ||
| | [`gcp.apphub.workload.id`](/docs/attributes-registry/gcp.md) | string | The name of the workload as configured in AppHub. | `my-workload` | `Required` |  | | ||
|
|
||
| **[1] `gcp.apphub.workload.criticality_type`:** [See AppHub properties and attributes](https://cloud.google.com/app-hub/docs/overview#properties-attributes) | ||
|
|
||
| **[2] `gcp.apphub.workload.environment_type`:** [See AppHub properties and attributes](https://cloud.google.com/app-hub/docs/overview#properties-attributes) | ||
|
|
||
| <!-- markdownlint-restore --> | ||
| <!-- prettier-ignore-end --> | ||
| <!-- END AUTOGENERATED TEXT --> | ||
| <!-- endsemconv --> | ||
|
|
||
| [DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| groups: | ||
| - id: resource.gcp.apphub.application | ||
| type: resource | ||
| stability: development | ||
| name: gcp.apphub.application | ||
| brief: > | ||
| Attributes denoting data from an Application in AppHub. | ||
| See [AppHub overview](https://cloud.google.com/app-hub/docs/overview). | ||
| attributes: | ||
| - ref: gcp.apphub.application.container | ||
| requirement_level: required | ||
| - ref: gcp.apphub.application.location | ||
| requirement_level: required | ||
| - ref: gcp.apphub.application.id | ||
| requirement_level: required | ||
| - id: resource.gcp.apphub.service | ||
| type: resource | ||
| stability: development | ||
| name: gcp.apphub.service | ||
| brief: > | ||
| Attributes denoting data from a Service in AppHub. | ||
| See [AppHub overview](https://cloud.google.com/app-hub/docs/overview). | ||
| attributes: | ||
| - ref: gcp.apphub.service.id | ||
| requirement_level: required | ||
| - ref: gcp.apphub.service.environment_type | ||
| requirement_level: required | ||
| - ref: gcp.apphub.service.criticality_type | ||
| requirement_level: required | ||
| - id: resource.gcp.apphub.workload | ||
| type: resource | ||
| stability: development | ||
| name: gcp.apphub.workload | ||
| brief: > | ||
| Attributes denoting data from a Workload in AppHub. | ||
| See [AppHub overview](https://cloud.google.com/app-hub/docs/overview). | ||
| attributes: | ||
| - ref: gcp.apphub.workload.id | ||
| requirement_level: required | ||
| - ref: gcp.apphub.workload.environment_type | ||
| requirement_level: required | ||
| - ref: gcp.apphub.workload.criticality_type | ||
| requirement_level: required |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.