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.

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

docs->add appsignal pino transport #2065

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

docs->add appsignal pino transport #2065

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f11ec0b
docs->add appsignal pino transport
luismiramirez Oct 17, 2024
af75f90
docs->make AppSignal transport example .cjs
luismiramirez Oct 18, 2024
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
30 changes: 24 additions & 6 deletions docs/transports.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@ In case you want to both use a custom transport, and output the log entries with
},
{
target: 'my-custom-transport',
options: { someParameter: true }
options: { someParameter: true }
}
]

Expand Down Expand Up @@ -423,6 +423,7 @@ PRs to this document are welcome for any new transports!

### Pino v7+ Compatible

+ [@appsignal/nodejs pino](#@appsignal/nodejs-pino)
+ [@axiomhq/pino](#@axiomhq/pino)
+ [@logtail/pino](#@logtail/pino)
+ [@macfja/pino-fingers-crossed](#macfja-pino-fingers-crossed)
Expand Down Expand Up @@ -467,6 +468,23 @@ PRs to this document are welcome for any new transports!
+ [pino-syslog](#pino-syslog)
+ [pino-websocket](#pino-websocket)

<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.


```javascript
const pino = require('pino');

pino({
transport: {
target: "@appsignal/nodejs/pino",
options: {
group: "optional-grou-name",
}
}
});
```

<a id="@axiomhq/pino"></a>
### @axiomhq/pino
Expand Down Expand Up @@ -575,9 +593,9 @@ const pino = require('pino')
const transport = pino.transport({
target: 'pino-axiom',
options: {
orgId: 'YOUR-ORG-ID',
token: 'YOUR-TOKEN',
dataset: 'YOUR-DATASET',
orgId: 'YOUR-ORG-ID',
token: 'YOUR-TOKEN',
dataset: 'YOUR-DATASET',
},
})
pino(transport)
Expand Down Expand Up @@ -697,7 +715,7 @@ https://github.com/deviantony/docker-elk to setup an ELK stack.
<a id="pino-discord-webhook"></a>
### pino-discord-webhook

[pino-discord-webhook](https://github.com/fabulousgk/pino-discord-webhook) is a Pino v7+ compatible transport to forward log events to a [Discord](http://discord.com) webhook from a dedicated worker.
[pino-discord-webhook](https://github.com/fabulousgk/pino-discord-webhook) is a Pino v7+ compatible transport to forward log events to a [Discord](http://discord.com) webhook from a dedicated worker.

```js
import pino from 'pino'
Expand Down Expand Up @@ -1117,7 +1135,7 @@ Example output for the "hello world" log:
<a id="pino-telegram-webhook"></a>
### pino-telegram-webhook

[pino-telegram-webhook](https://github.com/Jhon-Mosk/pino-telegram-webhook) is a Pino v7+ transport for sending messages to [Telegram](https://telegram.org/).
[pino-telegram-webhook](https://github.com/Jhon-Mosk/pino-telegram-webhook) is a Pino v7+ transport for sending messages to [Telegram](https://telegram.org/).

```js
const pino = require('pino');
Expand Down