Skip to content

Commit b0d222c

Browse files
zsoltgyulai94zsoltgyulai94
committed
Edits made based on review comments.
Signed-off-by: Zsolt Gyulai (zgyulai) <[email protected]>
1 parent 4a3ef94 commit b0d222c

File tree

6 files changed

+67
-21
lines changed

6 files changed

+67
-21
lines changed

‎_data/external_links.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,3 +142,23 @@ lunr-search-help:
142142
id: lunr-search-help
143143
url: https://lunrjs.com/guides/searching.html
144144
title: [ "Lunar search help" ]
145+
146+
grafana-loki:
147+
id: grafana-loki
148+
url: https://grafana.com/docs/loki/latest/
149+
title: [ "Grafana Loki" ]
150+
151+
grafana-loki-endpoint:
152+
id: grafana-loki-endpoint
153+
url: https://grafana.com/docs/loki/latest/reference/loki-http-api/#push-log-entries-to-loki
154+
title: [ "Grafana Loki HTTP endpoint" ]
155+
156+
app-default-cred:
157+
id: app-default-cred
158+
url: https://cloud.google.com/docs/authentication/application-default-credentials
159+
title: [ "Application Default Credentials" ]
160+
161+
grpc-core:
162+
id: grpc-core
163+
url: https://grpc.github.io/grpc/core/group__grpc__arg__keys.html
164+
title: [ "GRPC Core library documentation" ]

‎_includes/doc/admin-guide/options/channel-args.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
## channel-args()
22

3-
| Type:| |
4-
|Default:| -|
3+
| Type:| |
4+
|Default:| |
55

6-
*Description:* The `channel-args()` option is available in gRPC-based drivers. The option accepts name-value pairs and sets channel arguments defined in the [GRPC Core library documentation](https://grpc.github.io/grpc/core/group__grpc__arg__keys.html).
6+
*Description:* The `channel-args()` option is available in gRPC-based drivers. The option accepts name-value pairs and sets channel arguments defined in the GRPC Core library documentation.
77

88
### Example: channel-args() declaration
99

‎_includes/doc/admin-guide/options/gRPC-keep-alive.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,21 @@ This option configures the forwarding of [gRPC keepalive pings](https://grpc.io/
44

55
### max-pings-without-data()
66

7-
| Type:| integer|
8-
|Default:| |
7+
| Type:| integer|
8+
|Default:| |
99

1010
*Description:* This option definies the maximum number of gRPC pings that are allowed to be sent when there is no data/header frame. Any pings succeeding this limit are not sent. Setting this option to `0` disables this restriction and keep sending pings.
1111

1212
### time()
1313

14-
| Type:| number[milliseconds]|
15-
|Default:| |
14+
| Type:| number[milliseconds]|
15+
|Default:| |
1616

1717
*Description:* syslog-ng OSE sends a gRPC keepalive ping after the amount of time defined in the `time()` option elapsed.
1818

1919
### timeout()
2020

21-
| Type:| number[milliseconds]|
22-
|Default:| 10|
21+
| Type:| number[milliseconds]|
22+
|Default:| 10|
2323

2424
*Description:* The time syslog-ng OSE waits for an acknowledgement.

‎doc/_admin-guide/060_Sources/035_Jellyfin/README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: Jellyfin log source
3+
short_title: Jellyfin
4+
id: adm-src-jfin
5+
description: >-
6+
In syslog-ng OSE 4.7 and later versions it is possible to use the `jellyfin()` source to read [Jellyfin](https://jellyfin.org/) logs from its log file output.
7+
---
8+
9+
### Example: minimal configuration of jellyfin()
10+
11+
```config
12+
source s_jellyfin {
13+
jellyfin(
14+
base-dir("/path/to/jellyfin/root/log/dir")
15+
filename-pattern("log_*.log")
16+
);
17+
};
18+
```
19+
20+
The `jellyfin()` source can use wildcard-file() source options, since it is based on the `wildcard-file()` source.
21+
22+
The `jellyfin()` driver is a reusable configuration snippet. For more information on using configuration snippets, see Reusing configuration blocks. The source of this configuration snippet can be accessed as the Jellyfish config file on GitHub. [GitHub](https://github.com/syslog-ng/syslog-ng/blob/master/scl/jellyfin/jellyfin.conf).
23+
24+
For more information about Jellyfin logs, see the Jellyfin Main Configuration and Jellyfin Log Directory section in the Jellyfin documentation.
25+
* [https://jellyfin.org/docs/general/administration/configuration/#main-configuration](https://jellyfin.org/docs/general/administration/configuration/#main-configuration)
26+
* [https://jellyfin.org/docs/general/administration/configuration/#log-directory](https://jellyfin.org/docs/general/administration/configuration/#log-directory)

‎doc/_admin-guide/070_Destinations/125_Loki/001_Loki_options.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: loki() destination options
33
id: adm-dest-loki-opt
44
---
55

6-
The `loki()` driver sends messages to a Loki Grafna database and has the following options:
6+
The `loki()` driver sends messages to a Loki Grafana database and has the following options:
77

88
## auth()
99

@@ -13,7 +13,7 @@ The following sub-options are available for `auth()`.
1313

1414
### adc()
1515

16-
This option is an authentication method that is only available for destinations. For more information, see [Application Default Credentials](https://cloud.google.com/docs/authentication/application-default-credentials).
16+
This option is an authentication method that is only available for destinations. For more information, see Application Default Credentials.
1717

1818
### alts()
1919

@@ -82,15 +82,15 @@ labels(
8282

8383
## template()
8484

85-
| Type:| template or template-function|
86-
|Default:| $ISODATE $HOST $MSGHDR$MSG|
85+
| Type:| template or template-function|
86+
|Default:| ${ISODATE} ${HOST} ${MSGHDR} ${MSG}|
8787

8888
*Description:* This option specifies a template that defines the logformat to be used in the destination. For more information on macros and template functions, see Macros of syslog-ng OSE and Template functions of syslog-ng OSE.
8989

9090
## tenant-id()
9191

92-
| Type:| string|
93-
|Default:| -|
92+
| Type:| string|
93+
|Default:| |
9494

9595
Available in syslog-ng OSE 4.7 and later versions.
9696

@@ -112,8 +112,8 @@ loki(
112112

113113
## timestamp()
114114

115-
| Type:| `current`, `received`, `msg`|
116-
|Default:| current|
115+
| Type:| `current`, `received`, `msg`|
116+
|Default:| `current`|
117117

118118
*Description:* This option sets the timestamp type to be used for messages sent to a Loki destination.
119119

@@ -128,7 +128,7 @@ The timestamp types are the following.
128128

129129
## url()
130130

131-
| Type:| string|
131+
| Type:| string|
132132
|Default:| localhost:9095|
133133

134134
*Description:* This option specifies the URL of the Loki endpoint.

‎doc/_admin-guide/070_Destinations/125_Loki/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
title: 'loki(): Storing messages in a Grafna Loki database'
2+
title: 'loki(): Storing messages in a Grafana Loki database'
33
short_title: Loki
44
id: adm-dest-loki
55
description: >-
6-
In syslog-ng OSE 4.4 and later versions the `loki()` destination can be used to send log data to [Grafna Loki](https://grafana.com/docs/loki/latest/).
6+
In syslog-ng OSE 4.4 and later versions the `loki()` destination can be used to send log data to Grafana Loki.
77
8-
For more information on the message format, see [Grafna Loki HTTP endpoint](https://grafana.com/docs/loki/latest/reference/loki-http-api/#push-log-entries-to-loki).
8+
For more information on the message format, see Grafna Loki HTTP endpoint.
99
---
1010

1111
### Example: loki() destination configuration

0 commit comments

Comments
 (0)