Skip to content

docs(opentelemetry-resources): fix wrong sample code in readme #2289

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dyladan merged 2 commits into from
Jun 23, 2021
Merged

docs(opentelemetry-resources): fix wrong sample code in readme #2289

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c214e09
docs(opentelemetry-resources): fix wrong sample code in readme
alisabzevari Jun 16, 2021
68d1e59
Merge branch 'main' into opentelemetry-resources-readme
obecny Jun 21, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions packages/opentelemetry-resources/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

The OpenTelemetry Resource is an immutable representation of the entity producing telemetry. For example, a process producing telemetry that is running in a container on Kubernetes has a Pod name, it is in a namespace and possibly is part of a Deployment which also has a name. All three of these attributes can be included in the `Resource`.

[This document][resource-semantic_conventions] defines standard attributes for resources.
[This document][resource-semantic_conventions] defines standard attributes for resources which are accessible via [`@opentelemetry/semantic-conventions`](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-semantic-conventions).

## Installation

Expand All @@ -18,9 +18,11 @@ npm install --save @opentelemetry/resources
## Usage

```typescript
import { Resource, SERVICE_RESOURCE } from '@opentelemetry/resources';
import { ResourceAttributes } from '@opentelemetry/semantic-conventions';
import { Resource } from '@opentelemetry/resources';

const resource = new Resource({
[SERVICE_RESOURCE.NAME]: 'api-service',
[ResourceAttributes.SERVICE_NAME]: 'api-service',
});

const another_resource = new Resource({
Expand Down