|
| 1 | +/* |
| 2 | + * Copyright The OpenTelemetry Authors |
| 3 | + * SPDX-License-Identifier: Apache-2.0 |
| 4 | + */ |
| 5 | + |
| 6 | +package io.opentelemetry.semconv.incubating; |
| 7 | + |
| 8 | +import static io.opentelemetry.api.common.AttributeKey.stringKey; |
| 9 | + |
| 10 | +import io.opentelemetry.api.common.AttributeKey; |
| 11 | + |
| 12 | +// DO NOT EDIT, this is an Auto-generated file from |
| 13 | +// buildscripts/templates/registry/incubating_java/IncubatingSemanticAttributes.java.j2 |
| 14 | +@SuppressWarnings("unused") |
| 15 | +public final class CloudfoundryIncubatingAttributes { |
| 16 | + /** |
| 17 | + * The guid of the application. |
| 18 | + * |
| 19 | + * <p>Notes: |
| 20 | + * |
| 21 | + * <p>Application instrumentation should use the value from environment variable {@code |
| 22 | + * VCAP_APPLICATION.application_id}. This is the same value as reported by {@code cf app |
| 23 | + * <app-name> --guid}. |
| 24 | + */ |
| 25 | + public static final AttributeKey<String> CLOUDFOUNDRY_APP_ID = stringKey("cloudfoundry.app.id"); |
| 26 | + |
| 27 | + /** |
| 28 | + * The index of the application instance. 0 when just one instance is active. |
| 29 | + * |
| 30 | + * <p>Notes: |
| 31 | + * |
| 32 | + * <p>CloudFoundry defines the {@code instance_id} in the <a |
| 33 | + * href="https://github.com/cloudfoundry/loggregator-api#v2-envelope">Loggegator v2 envelope</a>. |
| 34 | + * It is used for logs and metrics emitted by CloudFoundry. It is supposed to contain the |
| 35 | + * application instance index for applications deployed on the runtime. |
| 36 | + * |
| 37 | + * <p>Application instrumentation should use the value from environment variable {@code |
| 38 | + * CF_INSTANCE_INDEX}. |
| 39 | + */ |
| 40 | + public static final AttributeKey<String> CLOUDFOUNDRY_APP_INSTANCE_ID = |
| 41 | + stringKey("cloudfoundry.app.instance.id"); |
| 42 | + |
| 43 | + /** |
| 44 | + * The name of the application. |
| 45 | + * |
| 46 | + * <p>Notes: |
| 47 | + * |
| 48 | + * <p>Application instrumentation should use the value from environment variable {@code |
| 49 | + * VCAP_APPLICATION.application_name}. This is the same value as reported by {@code cf apps}. |
| 50 | + */ |
| 51 | + public static final AttributeKey<String> CLOUDFOUNDRY_APP_NAME = |
| 52 | + stringKey("cloudfoundry.app.name"); |
| 53 | + |
| 54 | + /** |
| 55 | + * The guid of the CloudFoundry org the application is running in. |
| 56 | + * |
| 57 | + * <p>Notes: |
| 58 | + * |
| 59 | + * <p>Application instrumentation should use the value from environment variable {@code |
| 60 | + * VCAP_APPLICATION.org_id}. This is the same value as reported by {@code cf org <org-name> |
| 61 | + * --guid}. |
| 62 | + */ |
| 63 | + public static final AttributeKey<String> CLOUDFOUNDRY_ORG_ID = stringKey("cloudfoundry.org.id"); |
| 64 | + |
| 65 | + /** |
| 66 | + * The name of the CloudFoundry organization the app is running in. |
| 67 | + * |
| 68 | + * <p>Notes: |
| 69 | + * |
| 70 | + * <p>Application instrumentation should use the value from environment variable {@code |
| 71 | + * VCAP_APPLICATION.org_name}. This is the same value as reported by {@code cf orgs}. |
| 72 | + */ |
| 73 | + public static final AttributeKey<String> CLOUDFOUNDRY_ORG_NAME = |
| 74 | + stringKey("cloudfoundry.org.name"); |
| 75 | + |
| 76 | + /** |
| 77 | + * The UID identifying the process. |
| 78 | + * |
| 79 | + * <p>Notes: |
| 80 | + * |
| 81 | + * <p>Application instrumentation should use the value from environment variable {@code |
| 82 | + * VCAP_APPLICATION.process_id}. It is supposed to be equal to {@code VCAP_APPLICATION.app_id} for |
| 83 | + * applications deployed to the runtime. For system components, this could be the actual PID. |
| 84 | + */ |
| 85 | + public static final AttributeKey<String> CLOUDFOUNDRY_PROCESS_ID = |
| 86 | + stringKey("cloudfoundry.process.id"); |
| 87 | + |
| 88 | + /** |
| 89 | + * The type of process. |
| 90 | + * |
| 91 | + * <p>Notes: |
| 92 | + * |
| 93 | + * <p>CloudFoundry applications can consist of multiple jobs. Usually the main process will be of |
| 94 | + * type {@code web}. There can be additional background tasks or side-cars with different process |
| 95 | + * types. |
| 96 | + */ |
| 97 | + public static final AttributeKey<String> CLOUDFOUNDRY_PROCESS_TYPE = |
| 98 | + stringKey("cloudfoundry.process.type"); |
| 99 | + |
| 100 | + /** |
| 101 | + * The guid of the CloudFoundry space the application is running in. |
| 102 | + * |
| 103 | + * <p>Notes: |
| 104 | + * |
| 105 | + * <p>Application instrumentation should use the value from environment variable {@code |
| 106 | + * VCAP_APPLICATION.space_id}. This is the same value as reported by {@code cf space <space-name> |
| 107 | + * --guid}. |
| 108 | + */ |
| 109 | + public static final AttributeKey<String> CLOUDFOUNDRY_SPACE_ID = |
| 110 | + stringKey("cloudfoundry.space.id"); |
| 111 | + |
| 112 | + /** |
| 113 | + * The name of the CloudFoundry space the application is running in. |
| 114 | + * |
| 115 | + * <p>Notes: |
| 116 | + * |
| 117 | + * <p>Application instrumentation should use the value from environment variable {@code |
| 118 | + * VCAP_APPLICATION.space_name}. This is the same value as reported by {@code cf spaces}. |
| 119 | + */ |
| 120 | + public static final AttributeKey<String> CLOUDFOUNDRY_SPACE_NAME = |
| 121 | + stringKey("cloudfoundry.space.name"); |
| 122 | + |
| 123 | + /** |
| 124 | + * A guid or another name describing the event source. |
| 125 | + * |
| 126 | + * <p>Notes: |
| 127 | + * |
| 128 | + * <p>CloudFoundry defines the {@code source_id} in the <a |
| 129 | + * href="https://github.com/cloudfoundry/loggregator-api#v2-envelope">Loggregator v2 envelope</a>. |
| 130 | + * It is used for logs and metrics emitted by CloudFoundry. It is supposed to contain the |
| 131 | + * component name, e.g. "gorouter", for CloudFoundry components. |
| 132 | + * |
| 133 | + * <p>When system components are instrumented, values from the <a |
| 134 | + * href="https://bosh.io/docs/jobs/#properties-spec">Bosh spec</a> should be used. The {@code |
| 135 | + * system.id} should be set to {@code spec.deployment/spec.name}. |
| 136 | + */ |
| 137 | + public static final AttributeKey<String> CLOUDFOUNDRY_SYSTEM_ID = |
| 138 | + stringKey("cloudfoundry.system.id"); |
| 139 | + |
| 140 | + /** |
| 141 | + * A guid describing the concrete instance of the event source. |
| 142 | + * |
| 143 | + * <p>Notes: |
| 144 | + * |
| 145 | + * <p>CloudFoundry defines the {@code instance_id} in the <a |
| 146 | + * href="https://github.com/cloudfoundry/loggregator-api#v2-envelope">Loggregator v2 envelope</a>. |
| 147 | + * It is used for logs and metrics emitted by CloudFoundry. It is supposed to contain the vm id |
| 148 | + * for CloudFoundry components. |
| 149 | + * |
| 150 | + * <p>When system components are instrumented, values from the <a |
| 151 | + * href="https://bosh.io/docs/jobs/#properties-spec">Bosh spec</a> should be used. The {@code |
| 152 | + * system.instance.id} should be set to {@code spec.id}. |
| 153 | + */ |
| 154 | + public static final AttributeKey<String> CLOUDFOUNDRY_SYSTEM_INSTANCE_ID = |
| 155 | + stringKey("cloudfoundry.system.instance.id"); |
| 156 | + |
| 157 | + // Enum definitions |
| 158 | + |
| 159 | + private CloudfoundryIncubatingAttributes() {} |
| 160 | +} |
0 commit comments