@opentelemetry/resources
Version:
OpenTelemetry SDK resources
102 lines • 3.98 kB
JavaScript
"use strict";
/**
* Copyright 2020, OpenTelemetry Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
Object.defineProperty(exports, "__esModule", { value: true });
/**
* Semantic conventions for Resources
* https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/data-resource-semantic-conventions.md
*/
/** Attributes defining a running environment (e.g. Cloud, Data Center). */
exports.CLOUD_RESOURCE = {
/** Name of the cloud provider. Example values are aws, azure, gcp. */
PROVIDER: 'cloud.provider',
/** The cloud account id used to identify different entities. */
ACCOUNT_ID: 'cloud.account.id',
/** A specific geographical location where different entities can run. */
REGION: 'cloud.region',
/** Zones are a sub set of the region connected through low-latency links. */
ZONE: 'cloud.zone',
};
/**
* Attributes defining a compute unit (e.g. Container, Process, Lambda
* Function).
* */
exports.CONTAINER_RESOURCE = {
/** The container name. */
NAME: 'container.name',
/** The name of the image the container was built on. */
IMAGE_NAME: 'container.image.name',
/** The container image tag. */
IMAGE_TAG: 'container.image.tag',
};
/** Attributes defining a computing instance (e.g. host). */
exports.HOST_RESOURCE = {
/**
* Hostname of the host. It contains what the hostname command returns on the
* host machine.
*/
HOSTNAME: 'host.hostname',
/**
* Unique host id. For Cloud this must be the instance_id assigned by the
* cloud provider
*/
ID: 'host.id',
/**
* Name of the host. It may contain what hostname returns on Unix systems,
* the fully qualified, or a name specified by the user.
*/
NAME: 'host.name',
/** Type of host. For Cloud this must be the machine type.*/
TYPE: 'host.type',
/** Name of the VM image or OS install the host was instantiated from. */
IMAGE_NAME: 'host.image.name',
/** VM image id. For Cloud, this value is from the provider. */
IMAGE_ID: 'host.image.id',
/** The version string of the VM image */
IMAGE_VERSION: 'host.image.version',
};
/** Attributes defining a deployment service (e.g. Kubernetes). */
exports.K8S_RESOURCE = {
/** The name of the cluster that the pod is running in. */
CLUSTER_NAME: 'k8s.cluster.name',
/** The name of the namespace that the pod is running in. */
NAMESPACE_NAME: 'k8s.namespace.name',
/** The name of the pod. */
POD_NAME: 'k8s.pod.name',
/** The name of the deployment. */
DEPLOYMENT_NAME: 'k8s.deployment.name',
};
/** Attributes describing the telemetry library. */
exports.TELEMETRY_SDK_RESOURCE = {
/** The name of the telemetry library. */
NAME: 'telemetry.sdk.name',
/** The language of telemetry library and of the code instrumented with it. */
LANGUAGE: 'telemetry.sdk.language',
/** The version string of the telemetry library */
VERSION: 'telemetry.sdk.version',
};
/** Attributes describing a service instance. */
exports.SERVICE_RESOURCE = {
/** Logical name of the service. */
NAME: 'service.name',
/** A namespace for `service.name`. */
NAMESPACE: 'service.namespace',
/** The string ID of the service instance. */
INSTANCE_ID: 'service.instance.id',
/** The version string of the service API or implementation. */
VERSION: 'service.version',
};
//# sourceMappingURL=constants.js.map