# @opentelemetry/resource-detector-gcp

> OpenTelemetry SDK resource detector for GCP

Latest version **0.57.0** (published 2026-08-31) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @opentelemetry/resource-detector-gcp
pnpm add @opentelemetry/resource-detector-gcp
yarn add @opentelemetry/resource-detector-gcp
bun add @opentelemetry/resource-detector-gcp
```

## Health

**Score 75/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; has provenance; recently updated; high maintenance score; high quality score.

Warnings: low downloads; pre 1.0.

## Facts

| | |
|---|---|
| Version | 0.57.0 |
| Published | 2026-08-31 |
| First published | 2020-08-19 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | ^18.19.0 \|\| >=20.6.0 |
| Dependencies | 3 |
| Unpacked size | 169.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 927 |
| Author | OpenTelemetry Authors |
| Maintainers | dyladan, pichlermarc, overbalance, npmjs-account, trentm, martinkuba |
| Keywords | opentelemetry, nodejs, resources, stats, profiling |

## Links

- npm: https://www.npmjs.com/package/@opentelemetry/resource-detector-gcp
- Repository: https://github.com/open-telemetry/opentelemetry-js-contrib
- Homepage: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/packages/resource-detector-gcp#readme
- Issues: https://github.com/open-telemetry/opentelemetry-js-contrib/issues
- npm.io page: https://npm.io/package/@opentelemetry/resource-detector-gcp

## Dependencies (3)

- [gcp-metadata](https://npm.io/package/gcp-metadata.md) ^8.0.0
- [@opentelemetry/core](https://npm.io/package/@opentelemetry/core.md) ^2.0.0
- [@opentelemetry/resources](https://npm.io/package/@opentelemetry/resources.md) ^2.0.0

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 0.57.0 (latest) — 2026-08-31
- 0.24.1-alpha.7 (canary) — 2021-08-07
- 0.24.0 (next) — 2021-07-28
- 0.56.0 — 2026-07-23
- 0.55.0 — 2026-07-03
- 0.54.0 — 2026-06-11
- 0.53.0 — 2026-05-13
- 0.52.0 — 2026-05-06
- 0.51.0 — 2026-04-29
- 0.50.0 — 2026-04-17
- 0.49.0 — 2026-03-26
- 0.48.0 — 2026-03-04
- 0.47.0 — 2026-02-17
- 0.46.0 — 2026-01-22
- 0.45.0 — 2026-01-15
- … 150 more at https://npm.io/package/@opentelemetry/resource-detector-gcp/versions

## README

# OpenTelemetry Resource Detector for GCP

[![NPM Published Version][npm-img]][npm-url]
[![Apache License][license-image]][license-image]

Resource detector for Google Cloud Platform.

Compatible with OpenTelemetry JS API `1.0+` and SDK `2.0+`.

## Installation


```bash
npm install --save @opentelemetry/resource-detector-gcp
```

## Usage

```typescript
import { detectResources } from '@opentelemetry/resources';
import { gcpDetector } from '@opentelemetry/resource-detector-gcp'
const resource = await detectResources({
   detectors: [gcpDetector],
})

const tracerProvider = new NodeTracerProvider({ resource });
```

## Available detectors

This package implements Semantic Convention [Version 1.39.0](https://github.com/open-telemetry/semantic-conventions/blob/v1.39.0/docs/README.md)

### GCP Detector

| Resource Attribute      | Description                                                           |
|-------------------------|-----------------------------------------------------------------------|
| cloud.account.id        | Value of `project-id` from GCP Metadata project.                      |
| cloud.availability_zone | Value of `zone` from GCP Metadata instance (parsed from full path).   |
| cloud.platform          | The GCP platform where the application is running.                    |
| cloud.provider          | The cloud provider. In this context, it's always `gcp`                |
| cloud.region            | Value of `region` from GCP Metadata instance (parsed from full path). |
| faas.instance           | Value of `id` from GCP Metadata instance.                             |
| faas.name               | Value of Environment Variable `K_SERVICE`.                            |
| faas.version            | Value of Environment Variable `K_REVISION`.                           |
| host.id                 | Value of `id` from GCP Metadata instance.                             |
| host.name               | Value of `name` from GCP Metadata instance.                           |
| host.type               | Value of `machine-type` from GCP Metadata instance.                   |
| k8s.cluster.name        | Value of `attributes/cluster-name` from GCP Metadata instance.        |

## Useful links

- [GCP Metadata Documentation][]
- For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
- For more about OpenTelemetry JavaScript: <https://github.com/open-telemetry/opentelemetry-js>
- For help or feedback on this project, join us in [GitHub Discussions][discussions-url]

## License

Apache 2.0 - See [LICENSE][license-url] for more information.

[GCP Metadata Documentation]: https://cloud.google.com/compute/docs/metadata/overview
[discussions-url]: https://github.com/open-telemetry/opentelemetry-js/discussions
[license-url]: https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/LICENSE
[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat
[npm-url]: https://www.npmjs.com/package/@opentelemetry/resource-detector-gcp
[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fresource-detector-gcp.svg

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