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

docs: add @openobserve/openobserve-pino transports #2078

Merged
merged 4 commits into from
Nov 18, 2024

Conversation

ktx-kirtan
Copy link
Contributor

Hello,

We have written @openobserve/openobserve-pino v7+ transport for sending logs to OpenObserve

Feel free to review this and let us know if you have any questions.

Kirtan

Copy link
Member

@jsumners jsumners left a comment

Choose a reason for hiding this comment

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

We generally look for listed modules to include tests that provide a baseline level of quality assurance. Is this module tested?

Comment on lines 534 to 553
```
import pino from 'pino';
import OpenobserveTransport from '@openobserve/pino-openobserve';

const logger = pino({
level: 'info',
transport: {
target: OpenobserveTransport,
options: {
url: 'https://your-openobserve-server.com',
organization: 'your-organization',
streamName: 'your-stream',
auth: {
username: 'your-username',
password: 'your-password',
},
},
},
});
```
Copy link
Member

Choose a reason for hiding this comment

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

The other examples in this document are CJS. Please update yours to be consistent with the others.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This example is updated with the CJS

docs/transports.md Outdated Show resolved Hide resolved
docs/transports.md Outdated Show resolved Hide resolved
ktx-kirtan and others added 3 commits November 15, 2024 13:31
Co-authored-by: James Sumners <321201+jsumners@users.noreply.github.com>
Co-authored-by: James Sumners <321201+jsumners@users.noreply.github.com>
@ktx-kirtan
Copy link
Contributor Author

@jsumners Yes this module was published on npm for more than 9 months. The tests were also recently added. So yes it does provide a baseline level of quality assurance. Feel free to review here: https://github.com/openobserve/pino-openobserve

@ktx-kirtan ktx-kirtan requested a review from jsumners November 15, 2024 08:07
@jsumners jsumners merged commit 4ea00c2 into pinojs:main Nov 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants