@opentelemetry/resource-detector-aws
Version:
OpenTelemetry SDK resource detector for AWS
86 lines • 3.84 kB
JavaScript
/*
* Copyright The 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.
*/
import { context, diag } from '@opentelemetry/api';
import { suppressTracing } from '@opentelemetry/core';
import { ATTR_SERVICE_NAME, ATTR_SERVICE_VERSION, } from '@opentelemetry/semantic-conventions';
import { ATTR_CLOUD_PROVIDER, ATTR_CLOUD_PLATFORM, ATTR_SERVICE_NAMESPACE, ATTR_SERVICE_INSTANCE_ID, CLOUD_PROVIDER_VALUE_AWS, CLOUD_PLATFORM_VALUE_AWS_ELASTIC_BEANSTALK, } from '../semconv';
import * as fs from 'fs';
import * as util from 'util';
/**
* The AwsBeanstalkDetector can be used to detect if a process is running in AWS Elastic
* Beanstalk and return a {@link Resource} populated with data about the beanstalk
* plugins of AWS X-Ray. Returns an empty Resource if detection fails.
*
* See https://docs.amazonaws.cn/en_us/xray/latest/devguide/xray-guide.pdf
* for more details about detecting information of Elastic Beanstalk plugins
*/
const DEFAULT_BEANSTALK_CONF_PATH = '/var/elasticbeanstalk/xray/environment.conf';
const WIN_OS_BEANSTALK_CONF_PATH = 'C:\\Program Files\\Amazon\\XRay\\environment.conf';
class AwsBeanstalkDetector {
BEANSTALK_CONF_PATH;
static readFileAsync = util.promisify(fs.readFile);
static fileAccessAsync = util.promisify(fs.access);
constructor() {
if (process.platform === 'win32') {
this.BEANSTALK_CONF_PATH = WIN_OS_BEANSTALK_CONF_PATH;
}
else {
this.BEANSTALK_CONF_PATH = DEFAULT_BEANSTALK_CONF_PATH;
}
}
detect() {
const dataPromise = context.with(suppressTracing(context.active()), () => this._gatherData());
const attrNames = [
ATTR_CLOUD_PROVIDER,
ATTR_CLOUD_PLATFORM,
ATTR_SERVICE_NAME,
ATTR_SERVICE_NAMESPACE,
ATTR_SERVICE_VERSION,
ATTR_SERVICE_INSTANCE_ID,
];
const attributes = {};
attrNames.forEach(name => {
// Each resource attribute is determined asynchronously in _gatherData().
attributes[name] = dataPromise.then(data => data[name]);
});
return { attributes };
}
/**
* Async resource attributes for AWS Beanstalk configuration read from file.
*/
async _gatherData() {
try {
await AwsBeanstalkDetector.fileAccessAsync(this.BEANSTALK_CONF_PATH, fs.constants.R_OK);
const rawData = await AwsBeanstalkDetector.readFileAsync(this.BEANSTALK_CONF_PATH, 'utf8');
const parsedData = JSON.parse(rawData);
return {
[ATTR_CLOUD_PROVIDER]: CLOUD_PROVIDER_VALUE_AWS,
[ATTR_CLOUD_PLATFORM]: CLOUD_PLATFORM_VALUE_AWS_ELASTIC_BEANSTALK,
[ATTR_SERVICE_NAME]: CLOUD_PLATFORM_VALUE_AWS_ELASTIC_BEANSTALK,
[ATTR_SERVICE_NAMESPACE]: parsedData.environment_name,
[ATTR_SERVICE_VERSION]: parsedData.version_label,
[ATTR_SERVICE_INSTANCE_ID]: parsedData.deployment_id,
};
}
catch (e) {
diag.debug(`AwsBeanstalkDetector: did not detect resource: ${e.message}`);
return {};
}
}
}
export { AwsBeanstalkDetector };
export const awsBeanstalkDetector = new AwsBeanstalkDetector();
//# sourceMappingURL=AwsBeanstalkDetector.js.map