Skip to content

Commit 47605ea

Browse files
Add draft README.md without code owner
Code owners for the CloudFoundry module are yet to be determined. Signed-off-by: Karsten Schnitter <[email protected]>
1 parent 376696c commit 47605ea

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

cloudfoundry-resource/README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# OpenTelemetry CloudFoundry Resource Support
2+
3+
This module contains CloudFoundry resource detectors for OpenTelemetry.
4+
5+
The module detects environment variable `VCAP_APPLICATION`, which is present for applications deployed in CloudFoundry.
6+
This variable contains a JSON structure, which is parsed to fill the following attributes.
7+
8+
| Resource attribute | `VCAP_APPLICATION` field |
9+
|------------------------------|--------------------------|
10+
| cloudfoundry.app.id | application_id |
11+
| cloudfoundry.app.name | application_name |
12+
| cloudfoundry.app.instance.id | instance_index |
13+
| cloudfoundry.org.id | organization_id |
14+
| cloudfoundry.org.name | organization_name |
15+
| cloudfoundry.process.id | process_id |
16+
| cloudfoundry.process.type | process_type |
17+
| cloudfoundry.space.id | space_id |
18+
| cloudfoundry.space.name | space_name |
19+
20+
The resource attributes follow the [CloudFoundry semantic convention.](https://github.com/open-telemetry/semantic-conventions/blob/05b4c173bfdee2e972d252d14593b9fb653cc54a/docs/attributes-registry/cloudfoundry.md).
21+
A description of `VCAP_APPLICATION` is available in the [CloudFoundry documentation](https://docs.cloudfoundry.org/devguide/deploy-apps/environment-variable.html#VCAP-APPLICATION).
22+
23+
## Component owners
24+
25+
- TBD
26+
27+
Learn more about component owners in [component_owners.yml](../.github/component_owners.yml).

0 commit comments

Comments
 (0)