# CloudFoundry LLMS index: [llms.txt](/llms.txt) --- ## CloudFoundry App **Status:** ![Development](https://img.shields.io/badge/-development-blue) **type:** `cloudfoundry.app` **Description:** The application which is monitored. > [!warning] > This entity definition contains attributes without a role. > Stable Entities MUST NOT have attributes without a defined role. **Attributes:** | Role | Key | Stability | [Requirement Level](/docs/specs/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | --- | --- | | Other | [`cloudfoundry.app.id`](/docs/specs/semconv/registry/attributes/cloudfoundry.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | The guid of the application. [1] | `218fc5a9-a5f1-4b54-aa05-46717d0ab26d` | | Other | [`cloudfoundry.app.name`](/docs/specs/semconv/registry/attributes/cloudfoundry.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | The name of the application. [2] | `my-app-name` | **[1] `cloudfoundry.app.id`:** Application instrumentation should use the value from environment variable `VCAP_APPLICATION.application_id`. This is the same value as reported by `cf app --guid`. **[2] `cloudfoundry.app.name`:** Application instrumentation should use the value from environment variable `VCAP_APPLICATION.application_name`. This is the same value as reported by `cf apps`. ## CloudFoundry Org **Status:** ![Development](https://img.shields.io/badge/-development-blue) **type:** `cloudfoundry.org` **Description:** The organization of the application which is monitored. > [!warning] > This entity definition contains attributes without a role. > Stable Entities MUST NOT have attributes without a defined role. **Attributes:** | Role | Key | Stability | [Requirement Level](/docs/specs/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | --- | --- | | Other | [`cloudfoundry.org.id`](/docs/specs/semconv/registry/attributes/cloudfoundry.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | The guid of the CloudFoundry org the application is running in. [3] | `218fc5a9-a5f1-4b54-aa05-46717d0ab26d` | | Other | [`cloudfoundry.org.name`](/docs/specs/semconv/registry/attributes/cloudfoundry.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | The name of the CloudFoundry organization the app is running in. [4] | `my-org-name` | **[3] `cloudfoundry.org.id`:** Application instrumentation should use the value from environment variable `VCAP_APPLICATION.org_id`. This is the same value as reported by `cf org --guid`. **[4] `cloudfoundry.org.name`:** Application instrumentation should use the value from environment variable `VCAP_APPLICATION.org_name`. This is the same value as reported by `cf orgs`. ## CloudFoundry Process **Status:** ![Development](https://img.shields.io/badge/-development-blue) **type:** `cloudfoundry.process` **Description:** The process of the application which is monitored. > [!warning] > This entity definition contains attributes without a role. > Stable Entities MUST NOT have attributes without a defined role. **Attributes:** | Role | Key | Stability | [Requirement Level](/docs/specs/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | --- | --- | | Other | [`cloudfoundry.process.id`](/docs/specs/semconv/registry/attributes/cloudfoundry.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | The UID identifying the process. [5] | `218fc5a9-a5f1-4b54-aa05-46717d0ab26d` | | Other | [`cloudfoundry.process.type`](/docs/specs/semconv/registry/attributes/cloudfoundry.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | The type of process. [6] | `web` | **[5] `cloudfoundry.process.id`:** Application instrumentation should use the value from environment variable `VCAP_APPLICATION.process_id`. It is supposed to be equal to `VCAP_APPLICATION.app_id` for applications deployed to the runtime. For system components, this could be the actual PID. **[6] `cloudfoundry.process.type`:** CloudFoundry applications can consist of multiple jobs. Usually the main process will be of type `web`. There can be additional background tasks or side-cars with different process types. ## CloudFoundry Space **Status:** ![Development](https://img.shields.io/badge/-development-blue) **type:** `cloudfoundry.space` **Description:** The space of the application which is monitored. > [!warning] > This entity definition contains attributes without a role. > Stable Entities MUST NOT have attributes without a defined role. **Attributes:** | Role | Key | Stability | [Requirement Level](/docs/specs/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | --- | --- | | Other | [`cloudfoundry.space.id`](/docs/specs/semconv/registry/attributes/cloudfoundry.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | The guid of the CloudFoundry space the application is running in. [7] | `218fc5a9-a5f1-4b54-aa05-46717d0ab26d` | | Other | [`cloudfoundry.space.name`](/docs/specs/semconv/registry/attributes/cloudfoundry.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | The name of the CloudFoundry space the application is running in. [8] | `my-space-name` | **[7] `cloudfoundry.space.id`:** Application instrumentation should use the value from environment variable `VCAP_APPLICATION.space_id`. This is the same value as reported by `cf space --guid`. **[8] `cloudfoundry.space.name`:** Application instrumentation should use the value from environment variable `VCAP_APPLICATION.space_name`. This is the same value as reported by `cf spaces`. ## CloudFoundry System **Status:** ![Development](https://img.shields.io/badge/-development-blue) **type:** `cloudfoundry.system` **Description:** The system component which is monitored. > [!warning] > This entity definition contains attributes without a role. > Stable Entities MUST NOT have attributes without a defined role. **Attributes:** | Role | Key | Stability | [Requirement Level](/docs/specs/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values | | --- | --- | --- | --- | --- | --- | --- | | Other | [`cloudfoundry.system.id`](/docs/specs/semconv/registry/attributes/cloudfoundry.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | A guid or another name describing the event source. [9] | `cf/gorouter` | | Other | [`cloudfoundry.system.instance.id`](/docs/specs/semconv/registry/attributes/cloudfoundry.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Recommended` | string | A guid describing the concrete instance of the event source. [10] | `218fc5a9-a5f1-4b54-aa05-46717d0ab26d` | **[9] `cloudfoundry.system.id`:** CloudFoundry defines the `source_id` in the [Loggregator v2 envelope](https://github.com/cloudfoundry/loggregator-api#v2-envelope). It is used for logs and metrics emitted by CloudFoundry. It is supposed to contain the component name, e.g. "gorouter", for CloudFoundry components. When system components are instrumented, values from the [Bosh spec](https://bosh.io/docs/jobs/#properties-spec) should be used. The `system.id` should be set to `spec.deployment/spec.name`. **[10] `cloudfoundry.system.instance.id`:** CloudFoundry defines the `instance_id` in the [Loggregator v2 envelope](https://github.com/cloudfoundry/loggregator-api#v2-envelope). It is used for logs and metrics emitted by CloudFoundry. It is supposed to contain the vm id for CloudFoundry components. When system components are instrumented, values from the [Bosh spec](https://bosh.io/docs/jobs/#properties-spec) should be used. The `system.instance.id` should be set to `spec.id`.