Skip to content
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.

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

chore(docs:postgres): add usage instructions #539

Merged
merged 7 commits into from
Dec 26, 2019

Conversation

markwolff
Copy link
Member

Which problem is this PR solving?

Short description of the changes

  • Adds usage instructions for pg plugin. Since the pg module has a dependency on the pg-pool package, these instructions also include pg-pool references/links. These links are broken until pg-pool stuff gets merged in.

@codecov-io
Copy link

codecov-io commented Nov 14, 2019

Codecov Report

Merging #539 into master will decrease coverage by 2.16%.
The diff coverage is 90.38%.

@@            Coverage Diff             @@
##           master     #539      +/-   ##
==========================================
- Coverage   91.91%   89.74%   -2.17%     
==========================================
  Files         169      192      +23     
  Lines        8249    10095    +1846     
  Branches      726      911     +185     
==========================================
+ Hits         7582     9060    +1478     
- Misses        667     1035     +368
Impacted Files Coverage Δ
...ackages/opentelemetry-exporter-jaeger/src/types.ts 100% <ø> (ø) ⬆️
...pe-async-hooks/test/AsyncHooksScopeManager.test.ts 100% <ø> (ø) ⬆️
packages/opentelemetry-core/src/common/types.ts 100% <ø> (ø) ⬆️
...ntelemetry-web/src/enums/PerformanceTimingNames.ts 100% <ø> (ø)
packages/opentelemetry-node/src/config.ts 100% <ø> (ø)
...ges/opentelemetry-exporter-jaeger/src/transform.ts 100% <100%> (ø) ⬆️
...entelemetry-exporter-jaeger/test/transform.test.ts 100% <100%> (ø) ⬆️
...lugin-https/test/functionals/https-disable.test.ts 100% <100%> (ø)
...emetry-plugin-xml-http-request/src/enums/Format.ts 100% <100%> (ø)
packages/opentelemetry-plugin-ioredis/src/enums.ts 100% <100%> (ø)
... and 105 more

```

See [examples/postgres](https://github.com/open-telemetry/opentelemetry-js/tree/master/examples/postgres) for a short example.

## Supported Versions

- [pg](https://npmjs.com/package/pg): `7.x`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it necessary to add supported version of pg-pool here?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good call. Added in 0af2c10

@OlivierAlbertini OlivierAlbertini added the document Documentation-related label Nov 18, 2019
@dyladan dyladan merged commit 093a738 into open-telemetry:master Dec 26, 2019
@markwolff markwolff deleted the markwolff/add-pg-docs branch January 2, 2020 17:19
pichlermarc pushed a commit to dynatrace-oss-contrib/opentelemetry-js that referenced this pull request Dec 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
document Documentation-related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add usage instruction for postgres (pg) plugin
7 participants