# opentelemetry-resource-detector-deployment

> open telemetry resource detector for deployment

Latest version **0.30.0** (published 2024-05-21) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install opentelemetry-resource-detector-deployment
pnpm add opentelemetry-resource-detector-deployment
yarn add opentelemetry-resource-detector-deployment
bun add opentelemetry-resource-detector-deployment
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.30.0 |
| Published | 2024-05-21 |
| First published | 2021-06-14 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 18.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 168 |
| Maintainers | aspecto-release-bot |
| Keywords | opentelemetry |

## Links

- npm: https://www.npmjs.com/package/opentelemetry-resource-detector-deployment
- Repository: https://github.com/aspecto-io/opentelemetry-ext-js
- Issues: https://github.com/aspecto-io/opentelemetry-ext-js/issues
- npm.io page: https://npm.io/package/opentelemetry-resource-detector-deployment

## Dependencies (3)

- [@opentelemetry/resources](https://npm.io/package/@opentelemetry/resources.md) ~1.24.1
- [@opentelemetry/semantic-conventions](https://npm.io/package/@opentelemetry/semantic-conventions.md) ^1.24.1
- [opentelemetry-resource-detector-sync-api](https://npm.io/package/opentelemetry-resource-detector-sync-api.md) ^0.30.0

## Recent versions

- 0.30.0 (latest) — 2024-05-21
- 0.0.0-2024-05-16--12-47 (alpha) — 2024-05-16
- 0.29.0 — 2023-10-17
- 0.0.0-2023-10-17--13-06 — 2023-10-17
- 0.0.0-2023-07-26--14-48 — 2023-07-26
- 0.28.0 — 2022-07-11
- 0.0.0-2022-07-11--08-09 — 2022-07-11
- 0.27.1 — 2022-06-06
- 0.27.0 — 2022-06-02
- 0.0.0-2022-04-13--14-32 — 2022-04-13
- 0.0.0-2021-12-26--12-31 — 2021-12-26
- 0.0.0-2021-12-26--12-22 — 2021-12-26
- 0.0.0-2021-12-22--14-33 — 2021-12-22
- 0.0.0-2021-12-21--15-57 — 2021-12-21
- 0.0.0-2021-12-20--13-41 — 2021-12-20
- … 21 more at https://npm.io/package/opentelemetry-resource-detector-deployment/versions

## README

# OpenTelemetry Deployment Resource Detector for Node.js
[![NPM version](https://img.shields.io/npm/v/opentelemetry-resource-detector-deployment.svg)](https://www.npmjs.com/package/opentelemetry-resource-detector-deployment)

This module provides automatic resource detector for [Deployment](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/resource/semantic_conventions/deployment_environment.md)

## Installation

```bash
npm install --save opentelemetry-resource-detector-deployment
```

##  Usage

### Synchronous SDK Initialization
```js
import { detectSyncResources } from 'opentelemetry-resource-detector-sync-api';
import { deploymentSyncDetector } from 'opentelemetry-resource-detector-deployment';

const resource = detectSyncResources({
    detectors: [deploymentSyncDetector, /* add other sync detectors here */],
});
const tracerProvider = new NodeTracerProvider({ resource });
```

### Asynchronous SDK Initialization
```js
import { detectResources } from '@opentelemetry/resources';
import { deploymentDetector } from 'opentelemetry-resource-detector-deployment';

( async () => {
    const resource = await detectResources({
        detectors: [deploymentDetector, /* add other async detectors here */],
    });
    const tracerProvider = new NodeTracerProvider({ resource });
    // Initialize auto instrumentation plugins and register provider.
    // Make sure you don't 'require' instrumented packages elsewhere 
    // before they are registered here
})();
```

## Attributes
| Attribute | Type | Source |
| --- | --- | --- |
| `deployment.environment` | string | `process.env.NODE_ENV` |

---
_Source: https://npm.io/package/opentelemetry-resource-detector-deployment · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._