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 appsignal pino transport #2065

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

luismiramirez
Copy link

Hi there! 👋🏼

We've created an AppSignal pino transport and recently released it as part of our v3.5.1 integration.

This PR adds the transport to the v7+ compatible list.

@mcollina
Copy link
Member

is it covered by tests? does it have docs?


const logger = pino({
AppsignalPinoTransport({
client: Appsignal.client,
Copy link
Member

Choose a reason for hiding this comment

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

I don't think this would work with pino-transport

Copy link
Author

Choose a reason for hiding this comment

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

Could you provide more info about how it wouldn't work with pino-transport please? I'm trying to find some info about it, but I haven't found anything.

Copy link
Author

Choose a reason for hiding this comment

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

Hi @mcollina! Now it's compatible with pino-transport. I've updated the PR.

@luismiramirez
Copy link
Author

is it covered by tests? does it have docs?

Yes, we have a test-setup for it working with Fastify Pino logging: https://github.com/appsignal/test-setups/blob/main/nodejs/fastify/app/src/app.ts

And its docs page: https://docs.appsignal.com/logging/platforms/integrations/nodejs.html#usage-with-pino

docs/transports.md Outdated Show resolved Hide resolved
<a id="@appsignal/nodejs-pino"></a>
### @appsignal/nodejs

[@appsignal/nodejs](https://www.npmjs.com/package/@appsignal/nodejs) [`AppsignalPinoTransport`](https://github.com/appsignal/appsignal-nodejs/blob/337eed9b72194f9500a685410fbfc9197c4db911/src/pino_transport.ts) is the official [AppSignal](https://appsignal.com/) transport for Pino.
Copy link
Member

Choose a reason for hiding this comment

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

@luismiramirez I see that you have had to update this PR at least once merely to update the hash in the URL. Can you provide a URL that doesn't need to be updated so often? It would be better if the module were in a repo dedicated to its maintenance.

Copy link
Author

Choose a reason for hiding this comment

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

@jsumners would it be better if I directly link to the appsignal-nodejs repo instead?

Copy link
Member

Choose a reason for hiding this comment

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

Not in my opinion. I would expect to see a repo dedicated to the module when clicking on the link. I'm not blocking this, and we are currently only waiting on @mcollina to re-review, but the way you have the module homed, the following are all true:

  1. You can't link directly to it without using a URL that could disappear (if you link to the "main" branch and then later change the structure of the repo it will 404).
  2. It's super difficult to find the source code for the module because it's mixed in with other things.
  3. It's pretty much impossible to figure out what changes apply only to the module because the commit history is obscured by all of the other things in the repo.

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.

3 participants