Skip to content

Commit 62cfd10

Browse files
committed
docs: Update website documentation with seq and logEntries plugins
1 parent 4bfce5e commit 62cfd10

File tree

4 files changed

+84
-0
lines changed

4 files changed

+84
-0
lines changed

docs/.vuepress/config.js

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,14 @@ module.exports = {
8787
text: 'Plugins',
8888
link: '/plugins',
8989
items: [
90+
{
91+
text: 'LogEntries',
92+
link: '/appenders/logentries.md'
93+
},
94+
{
95+
text: 'Seq',
96+
link: '/appenders/seq.md'
97+
},
9098
{
9199
text: 'Smtp',
92100
link: '/appenders/smtp.md'
@@ -137,6 +145,8 @@ module.exports = {
137145
{ title: 'File date', path: '/appenders/file-date' },
138146
{ title: 'Stdout', path: '/appenders/stdout' },
139147
{ title: 'StdErr', path: '/appenders/stderr' },
148+
{ title: 'LogEntries', path: '/appenders/logentries' },
149+
{ title: 'Seq', path: '/appenders/seq' },
140150
{ title: 'Smtp', path: '/appenders/smtp' },
141151
{ title: 'Custom appender', path: '/appenders/custom' }
142152
]
@@ -169,6 +179,8 @@ module.exports = {
169179
'/appenders/file-date',
170180
'/appenders/stdout',
171181
'/appenders/stderr',
182+
'/appenders/logentries',
183+
'/appenders/seq',
172184
'/appenders/smtp',
173185
'/layouts/basic',
174186
'/layouts/colored',

docs/appenders/logentries.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# LogEntries Appender
2+
3+
Sends log events to a [LogEntries](https://www.npmjs.com/package/le_node) server.
4+
5+
```bash
6+
npm install --save @tsed/logger-logentries le_node
7+
```
8+
9+
## Configuration
10+
11+
* `type` - `smtp`
12+
* `options.token` - LogEntries token
13+
14+
See all available options for LogEntries [here](https://www.npmjs.com/package/le_node).
15+
16+
## Example
17+
18+
```typescript
19+
import {Logger} from "@tsed/logger";
20+
import "@tsed/logger-logentries"
21+
22+
const logger = new Logger("loggerName");
23+
24+
logger.appenders.set("stdout", {
25+
type: "logentries",
26+
level: ["info"],
27+
options: {
28+
token: "the token"
29+
// other options of logentries
30+
}
31+
});
32+
```

docs/appenders/seq.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Seq Appender
2+
3+
Sends log events to a [Seq](https://www.npmjs.com/package/bunyan-seq) server.
4+
5+
```bash
6+
npm install --save @tsed/seq bunyan bunyan-seq @types/bunyan @types/bunyan-seq
7+
```
8+
9+
## Configuration
10+
11+
* `type` - `seq`
12+
* `options.url` - The url log server
13+
* `options.apiKey` - The apiKey
14+
15+
See all available options for Seq [here](https://www.npmjs.com/package/bunyan-seq).
16+
17+
## Example
18+
19+
```typescript
20+
import {Logger} from "@tsed/logger";
21+
import "@tsed/logger-seq"
22+
23+
const logger = new Logger("loggerName");
24+
25+
logger.appenders.set("stdout", {
26+
type: "seq",
27+
level: ["info"],
28+
options: {
29+
url: 'http://localhost:5341',
30+
apiKey: "the token"
31+
// other Seq options
32+
}
33+
});
34+
```

docs/readme.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,12 @@ frameworks:
6565
- title: Yarn
6666
href: https://yarnpkg.com/
6767
src: data:image/svg+xml;base64,PHN2ZyBpZD0iTGF5ZXJfMSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB2aWV3Qm94PSIwIDAgMTE1NC44IDUxOCI+PHN0eWxlPi5zdDB7ZmlsbDojMmM4ZWJifS5zdDF7ZmlsbDojZmZmfTwvc3R5bGU+PHBhdGggY2xhc3M9InN0MCIgZD0iTTcxOC42IDI1Ny44Yy04IDI3LjYtMjAuOCA0Ny42LTM1LjIgNjMuNlYxODFjMC05LjYtOC40LTE3LjYtMjEuNi0xNy42LTUuNiAwLTEwLjQgMi44LTEwLjQgNi44IDAgMi44IDEuNiA1LjIgMS42IDEyLjh2NjQuNGMtNC44IDI4LTE2LjggNTQtMzIuOCA1NC0xMS42IDAtMTguNC0xMS42LTE4LjQtMzMuMiAwLTMzLjYgNC40LTUxLjIgMTEuNi04MC44IDEuNi02IDEzLjItMjItNi40LTIyLTIxLjIgMC0xOC40IDgtMjEuMiAxNC44IDAgMC0xMy40IDQ3LjYtMTMuNCA5MCAwIDM0LjggMTQuNiA1Ny42IDQxLjQgNTcuNiAxNy4yIDAgMjkuNi0xMS42IDM5LjItMjcuNlYzNTFjLTI2LjQgMjMuMi00OS42IDQzLjYtNDkuNiA4NCAwIDI1LjYgMTYgNDYgMzguNCA0NiAyMC40IDAgNDEuNi0xNC44IDQxLjYtNTYuOFYzNTVjMjEuNi0xOC44IDQ0LjgtNDIuNCA1OC40LTg4LjguNC0xLjYuNC0zLjYuNC00IDAtNy42LTcuNi0xNi40LTE0LTE2LjQtNCAwLTcuMiAzLjYtOS42IDEyem0tNzYuOCAxOThjLTYuNCAwLTEwLjQtOS42LTEwLjQtMjIgMC0yNCA4LjgtMzkuMiAyMS42LTUyLjR2NDIuOGMwIDcuNiAxLjYgMzEuNi0xMS4yIDMxLjZ6Ii8+PHBhdGggY2xhc3M9InN0MCIgZD0iTTgzMy40IDMwMWMtOS42IDAtMTMuNi05LjYtMTMuNi0xOC40di02NmMwLTkuNi04LjQtMTcuNi0yMS42LTE3LjYtNS42IDAtMTAuNCAyLjgtMTAuNCA2LjggMCAyLjggMS42IDUuMiAxLjYgMTIuOHY2MS42Qzc4NSAyOTEuNCA3NzcuOCAzMDEgNzY3IDMwMWMtMTQgMC0yMi44LTEyLTIyLjgtMzIuOCAwLTU3LjYgMzUuNi04My42IDY2LTgzLjYgNCAwIDggLjggMTEuNi44IDQgMCA1LjItMi40IDUuMi05LjIgMC0xMC40LTcuNi0xNi44LTE4LjQtMTYuOC00OC44IDAtOTUuMiA0MC44LTk1LjIgMTA3LjYgMCAzNCAxNi40IDYwLjQgNDcuNiA2MC40IDE1LjIgMCAyNi40LTcuMiAzNC40LTE2LjQgNiA5LjYgMTYuOCAxNi40IDMwLjggMTYuNCAzNC40IDAgNTAuNC0zNiA1Ny4yLTYyLjQuNC0xLjYuNC0yLjQuNC0yLjggMC03LjYtNy42LTE2LjQtMTQtMTYuNC00IDAtOCAzLjYtOS42IDEyLTMuNiAxNy42LTEwLjggNDMuMi0yNi44IDQzLjJ6Ii8+PHBhdGggY2xhc3M9InN0MCIgZD0iTTk0OSAzMjcuNGMzNC40IDAgNTAtMzYgNTcuMi02Mi40IDAtLjguNC0xLjYuNC0yLjggMC03LjYtNy42LTE2LjQtMTQtMTYuNC00IDAtOCAzLjYtOS42IDEyLTMuNiAxNy42LTEwLjQgNDMuMi0yOC44IDQzLjItMTAuOCAwLTE2LTEwLjQtMTYtMjEuNiAwLTQwIDE4LTg3LjIgMTgtOTIgMS42LTkuMi0xNC40LTIyLjQtMTkuMi0yMi40aC0yMC44Yy00IDAtOCAwLTIxLjItMS42LTQuNC0xNi40LTE1LjYtMjEuMi0yNS4yLTIxLjItMTAuNCAwLTIwIDcuMi0yMCAxOC40IDAgMTEuNiA3LjIgMjAgMTcuMiAyNS42LS40IDIwLjQtMiA1My42LTYuNCA2OS42LTMuNiAxMy42IDE3LjIgMjggMjIuNCAxMS4yIDcuMi0yMy4yIDkuNi01OCAxMC03My42aDM0LjhjLTEyLjggMzQuNC0yMCA2Mi44LTIwIDg4LjQgMCAzNS4yIDIyLjQgNDUuNiA0MS4yIDQ1LjZ6Ii8+PHBhdGggY2xhc3M9InN0MCIgZD0iTTk4NC42IDMwOS44YzAgMTQuOCAxMS4yIDE3LjYgMTkuMiAxNy42IDExLjYgMCAxMS4yLTkuNiAxMS4yLTE3LjJ2LTU4LjRjMi44LTMxLjYgMjcuNi02NiAzOS4yLTY2IDcuNiAwIDguNCAxMC40IDguNCAyMi44djgxLjJjMCAyMC40IDEyLjQgMzcuNiAzMy42IDM3LjYgMzQuNCAwIDUxLjQtMzYgNTguMi02Mi40LjQtMS42LjQtMi40LjQtMi44IDAtNy42LTcuNi0xNi40LTE0LTE2LjQtNCAwLTggMy42LTkuNiAxMi0zLjYgMTcuNi0xMS44IDQzLjItMjcuOCA0My4yLTEwLjQgMC0xMC40LTE0LjgtMTAuNC0xOC40di04Mi44YzAtMTguNC02LjQtNDAuNC0zMy4yLTQwLjQtMTkuNiAwLTM0IDE3LjItNDQuOCAzOS42di0xOGMwLTkuNi04LjQtMTcuNi0yMS42LTE3LjYtNS42IDAtMTAuNCAyLjgtMTAuNCA2LjggMCAyLjggMS42IDUuMiAxLjYgMTIuOHYxMjYuOHpNMjU5IDBjMTQzIDAgMjU5IDExNiAyNTkgMjU5UzQwMiA1MTggMjU5IDUxOCAwIDQwMiAwIDI1OSAxMTYgMCAyNTkgMHoiLz48cGF0aCBjbGFzcz0ic3QxIiBkPSJNNDM1LjIgMzM3LjVjLTEuOC0xNC4yLTEzLjgtMjQtMjkuMi0yMy44LTIzIC4zLTQyLjMgMTIuMi01NS4xIDIwLjEtNSAzLjEtOS4zIDUuNC0xMyA3LjEuOC0xMS42LjEtMjYuOC01LjktNDMuNS03LjMtMjAtMTcuMS0zMi4zLTI0LjEtMzkuNCA4LjEtMTEuOCAxOS4yLTI5IDI0LjQtNTUuNiA0LjUtMjIuNyAzLjEtNTgtNy4yLTc3LjgtMi4xLTQtNS42LTYuOS0xMC04LjEtMS44LS41LTUuMi0xLjUtMTEuOS40QzI5My4xIDk2IDI4OS42IDkzLjggMjg2LjkgOTJjLTUuNi0zLjYtMTIuMi00LjQtMTguNC0yLjEtOC4zIDMtMTUuNCAxMS0yMi4xIDI1LjItMSAyLjEtMS45IDQuMS0yLjcgNi4xLTEyLjcuOS0zMi43IDUuNS00OS42IDIzLjgtMi4xIDIuMy02LjIgNC0xMC41IDUuNmguMWMtOC44IDMuMS0xMi44IDEwLjMtMTcuNyAyMy4zLTYuOCAxOC4yLjIgMzYuMSA3LjEgNDcuNy05LjQgOC40LTIxLjkgMjEuOC0yOC41IDM3LjUtOC4yIDE5LjQtOS4xIDM4LjQtOC44IDQ4LjctNyA3LjQtMTcuOCAyMS4zLTE5IDM2LjktMS42IDIxLjggNi4zIDM2LjYgOS44IDQyIDEgMS42IDIuMSAyLjkgMy4zIDQuMi0uNCAyLjctLjUgNS42LjEgOC42IDEuMyA3IDUuNyAxMi43IDEyLjQgMTYuMyAxMy4yIDcgMzEuNiAxMCA0NS44IDIuOSA1LjEgNS40IDE0LjQgMTAuNiAzMS4zIDEwLjZoMWM0LjMgMCA1OC45LTIuOSA3NC44LTYuOCA3LjEtMS43IDEyLTQuNyAxNS4yLTcuNCAxMC4yLTMuMiAzOC40LTEyLjggNjUtMzAgMTguOC0xMi4yIDI1LjMtMTQuOCAzOS4zLTE4LjIgMTMuNi0zLjMgMjIuMS0xNS43IDIwLjQtMjkuNHptLTIzLjggMTQuN2MtMTYgMy44LTI0LjEgNy4zLTQzLjkgMjAuMi0zMC45IDIwLTY0LjcgMjkuMy02NC43IDI5LjNzLTIuOCA0LjItMTAuOSA2LjFjLTE0IDMuNC02Ni43IDYuMy03MS41IDYuNC0xMi45LjEtMjAuOC0zLjMtMjMtOC42LTYuNy0xNiA5LjYtMjMgOS42LTIzcy0zLjYtMi4yLTUuNy00LjJjLTEuOS0xLjktMy45LTUuNy00LjUtNC4zLTIuNSA2LjEtMy44IDIxLTEwLjUgMjcuNy05LjIgOS4zLTI2LjYgNi4yLTM2LjkuOC0xMS4zLTYgLjgtMjAuMS44LTIwLjFzLTYuMSAzLjYtMTEtMy44Yy00LjQtNi44LTguNS0xOC40LTcuNC0zMi43IDEuMi0xNi4zIDE5LjQtMzIuMSAxOS40LTMyLjFzLTMuMi0yNC4xIDcuMy00OC44YzkuNS0yMi41IDM1LjEtNDAuNiAzNS4xLTQwLjZzLTIxLjUtMjMuOC0xMy41LTQ1LjJjNS4yLTE0IDcuMy0xMy45IDktMTQuNSA2LTIuMyAxMS44LTQuOCAxNi4xLTkuNSAyMS41LTIzLjIgNDguOS0xOC44IDQ4LjktMTguOHMxMy0zOS41IDI1LTMxLjhjMy43IDIuNCAxNyAzMiAxNyAzMnMxNC4yLTguMyAxNS44LTUuMmM4LjYgMTYuNyA5LjYgNDguNiA1LjggNjgtNi40IDMyLTIyLjQgNDkuMi0yOC44IDYwLTEuNSAyLjUgMTcuMiAxMC40IDI5IDQzLjEgMTAuOSAyOS45IDEuMiA1NSAyLjkgNTcuOC4zLjUuNC43LjQuN3MxMi41IDEgMzcuNi0xNC41YzEzLjQtOC4zIDI5LjMtMTcuNiA0Ny40LTE3LjggMTcuNS0uMyAxOC40IDIwLjIgNS4yIDIzLjR6Ii8+PC9zdmc+
68+
- title: Seq
69+
href: https://datalust.co/seq
70+
src: https://blog.datalust.co/content/images/2018/09/Seq-380px-1.png
71+
- title: LogEntries
72+
href: https://logentries.com/
73+
src: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAJcAAACXCAMAAAAvQTlLAAAApVBMVEX5dw3t7e3////5cwDt8PP5dQTt6+fyvZb4hS34axD5cQDt7/D5dwD4aAD//fvt7Or/+fPu4dX+59T92Lz5fBX5giX/9e3+7+P928Pyx6Xwy63v2sjt5t76snv5jjr5fx32mlLx0br2lUr3o2j2kEL0sH7zuIz0qG390bH8vIv7o2D8wpf8x5/7t5H9zaf+4sv7qn35fCv5gzn5jUz5dx76lVz6nmuVcCaaAAAIr0lEQVR4nO2ce3OqPBCH0ZhKQwTkIlorIGi5aLU9t+//0V5AbQtsgkS0fWf8/XHmzBTMk80m2WwSpN7PlPTdAAzdudrpztVOd652unO1052rnf7PXIoy6FCKonTAlSFp4+Vs2JlmT/NnZdCIxuVSFG38tHBtS8KoK2HJk/3h/LnHR+NxKc/LtUwJxlKnwhgRK5iNuWRsLkVZhjbtmOmDDdHV5nkgwKWM117Xliqj0eBJY5qMxaUtV+iaVLmQtX5mgcFcijaT0ZWppNxk4ZjRliCXor141zbWkSyYwxYDubSXa/l7TWgFg0Fc2uxG1irA/DEEBnApS/l2WJJEF5Dz17mU8eoGLv8VbHiWvZT1bbEkLAMuVuNSljd0roNQ1Gwv5Tm8NZaErWXNYDWupX1zLolGD01c2q29KxfgYRUuZXzTMeIk+tJgr8ET/QasbHCtNmSVa0EafgIfo85Ohb1qQ1a4NJdbIkaSHKRhGshWm9jMklCD16LZgMeljLm9EXnhbu/oqu4YcWQ3dpCjWbG93UUryn2crPlcS4tTDI32ev8k3QgxtyhM7CTJvRX5k77uTFPOT0so5frXYMYuhgb7fllmwOkkWN5kOFGGjjfF01Nej0Irjcs1ZDUjthZOvyonZVtsVdTCkAmhh/pseB6C5Qc+F6MgTLZ6DavfnzDBcHJ4YpsmsVr8L+K1uiAXtrYAVe5lEcMKWJ5UHnVJvnS04OcFuaxEhbn6DitYI9Wa7FyE3WQHzydiXCSFGvEgk2EwtKr64z7dGKq6Ad1fiAtbdZf/VFh/JR+3SFo0pOpM43jvfJpbB11SiAslHKz+tBZH2r5rIbmoi/H2Psr06/WzZqCBRbiwbfC4Jn7lHZI6znQ3zf8W/xqNHjONRr+np+dVaMUswoUitnflSioG+PT4mBRUBdmf46isTqFxX4SLMsaIk3aVguipzZz3D6wM7G/hb04CLh8EuLA35UBlMsslYfno5OrrF6zHxz9xjhXAK3kRLrk6L1ZUcXwSncz1u8Q1esvcwWEkGIS4uG5fsxcKzEND7t/LXL+zhtRtOO68hr3iqn95/jqvyvTPY4nrV47rU9LR+NXoX7URHGMSZj42fQe41H2yAjqk0Li642LpQKBAgqzNjF/ldvx7nMmd6oAnyIUWrEn7UMyq7srEzWyj/ytzvR5/ZhJ0xFWbgUsya6ELxrJZOF65GU/dx+iqHSm3IevNaB9DW/Xt67j6MTpvOpqHJORyGtKpmYt8zFvOv9GRbDR6y39Dz/8JgKFCMP7iGCyplZKvf46avBbhRBZQbHOiSeQvttVh5QIu7DKHVgOIP60v1TBe//39+7YtGlZdE0LgFa5gHE0XjJBCTYDwE/s5hnGsiz6ZHF822Flu0fUQy/X34Pocr/tGIsu7ilvq7L0KUS4Eh9I6MBQV1Ug9ghHZVB7fMZe2olwSAQfXmPV4kZkgi8NTE8c4tKQTMJfNolzYBmZJ5iLtCBcf3Grl2gfLTZi5W2EuCYfVhWrm9PxcEz14fpI1qZdNAKrhd9+OUFixb8h5WsaHDyLfMTYu27riXBIJq1zcjEOu1SJ2juEs9V2JU4sLuDCtdMl9YyoWEUJd+VgtfiJSnKs2G0VNqdhDiWflOy/iikpYDsddWusSLlyOw9iD5K25SgsQddFlrvwSLskyvzYjEKV/E1dpAWLwM/235ColKqDA60dwdbofeFk7xj/TXmW/B5aN38NVTqDoQF71e7iQXwry4cTyN3Cdws9rOP5F9ioHYGp61rx9dS60qkT4BmNPpVwgwtTy8gOK14pz6ku1dXMARuU02cZmvE1Si0cmzoWC2krNYazSTmUR6m+MycHK6mQacbZsxbmsuIqVRay8EAx54b7c8ntGMvoSLhJCmQCTeZYH03RaW3E6C9ZesvB6m8KZk50Hv0DsTW1Zl0lnHYMQ3Rdl7nmYUFNmxmIkgNS0031RZj4nGy38qtNgvAI3nQ9NCacCxLi4GVYn8b6k5DEhXsLbiIBdUjAvZ3IKyt3ZtbJxszgeY6dbbpYYSjCKciGfX1JGZiZRmKZREhvcnHrxLDRNiOWj+eY6SJ985AUbBKUPhPL3PtTlxQUdPBHaF2UeUhATlDUT4YJmoEsERbrX2OdrKyiHLcLFTt4LcgERuAjX6odydW4vIJ4U4YIy0ZcIOgkjNK523B8dIOMidA6Gv1/bWnFH4ypyG2biQnqusyrQ2f4jru7z1DSZbhZhGEbr7bRxjtxDQb4Yl82fIPWtb2OaRTmYYs9viHP0sLM4h7FpdbLVziWfS0OMiLflVKPL83KZwdhdcp9Wl4WIpuzAyISzGqLrDtYcqW/AU2ZewnAzVjZPfF8UAlNNF95ewcSNIbIpa8e2iWvGWqciN675mLFmrB6Liizq01fMzGFjl3sOWXlilZP52LpsASdxebfFMHWTcs+cJOwEEAr4XHP2JR1M5K1zGDlV3TFTi79Dlr9gLaafbyQ25wUS8c+5P/OyzIjK0SY2zXgTufScKwsY0WBRvPESytwXyAuXq6fwd1eygizLkmjT9YMvdcFUKt5o2HKu3iCq3u8YdpicPF9Irl7qq9prfk5ysnuuqOL2tXtNz/wc4JVkzXoNXL3ZN1wgwkHtbmbtftq40/2V8wTcgKzff+x0H+MsIbd+lbV+//H2Hkarl5pAew2ebtwlaVq7ZQje+9Wa9wu6FHahm9LQfeSbXhnF3tOZ96SzPnk7F8N0ePa98t5g3uVZEj7WC+BcLK5sOmIf1eoUyxs+tPg+QN6Uixt8IoC6oG9xuDLnH177Sw/ZuonxMQUOV0/pzSPrijbL4uwZow25XDnZMpLPiktbCyErGLI+idHElZE9zF98D5F8id+Z8kN0ctTwOZim7/oovYf5bJ2u5M7kBtHLcqw1fD7njO8gKYNBT9MeupKm5Z9Caiz1//zdqO/Qnaud7lztdOdqpztXO9252unO1U7/AZRuy7eyIEWeAAAAAElFTkSuQmCC
6874
---
6975
::: slot hero-brand
7076
<span class="block sm:inline mb-10 sm:mb-0 sm:text-bold text-7xl sm:text-5xl font-medium"><span class="text-blue">Ts</span>.Logger</span><br/>

0 commit comments

Comments
 (0)