-
Notifications
You must be signed in to change notification settings - Fork 3.5k
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
[chore]docs; update admonition syntax #9409
Closed
Closed
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -30,9 +30,11 @@ docker run --log-driver=loki \ | |
grafana/grafana | ||
``` | ||
|
||
> **Note**: The Loki logging driver still uses the json-log driver in combination with sending logs to Loki, this is mainly useful to keep the `docker logs` command working. | ||
> You can adjust file size and rotation using the respective log option `max-size` and `max-file`. Keep in mind that default values for these options are not taken from json-log configuration. | ||
> You can deactivate this behavior by setting the log option `no-file` to true. | ||
{{% admonition type="note" %}} | ||
The Loki logging driver still uses the json-log driver in combination with sending logs to Loki, this is mainly useful to keep the `docker logs` command working. | ||
You can adjust file size and rotation using the respective log option `max-size` and `max-file`. Keep in mind that default values for these options are not taken from json-log configuration. | ||
You can deactivate this behavior by setting the log option `no-file` to true. | ||
{{% /admonition %}} | ||
|
||
## Change the default logging driver | ||
|
||
|
@@ -61,9 +63,11 @@ Options for the logging driver can also be configured with `log-opts` in the | |
} | ||
``` | ||
|
||
> **Note**: log-opt configuration options in daemon.json must be provided as | ||
> strings. Boolean and numeric values (such as the value for loki-batch-size in | ||
> the example above) must therefore be enclosed in quotes (`"`). | ||
{{% admonition type="note" %}} | ||
log-opt configuration options in daemon.json must be provided as | ||
strings. Boolean and numeric values (such as the value for loki-batch-size in | ||
the example above) must therefore be enclosed in quotes (`"`). | ||
{{% /admonition %}} | ||
|
||
After changing `daemon.json`, restart the Docker daemon for the changes to take | ||
effect. All **newly created** containers from that host will then send logs to Loki via the driver. | ||
|
@@ -98,9 +102,11 @@ docker-compose -f docker-compose.yaml up | |
|
||
Once deployed, the Grafana service will send its logs to Loki. | ||
|
||
> **Note**: stack name and service name for each swarm service and project name | ||
> and service name for each compose service are automatically discovered and | ||
> sent as Loki labels, this way you can filter by them in Grafana. | ||
{{% admonition type="note" %}} | ||
stack name and service name for each swarm service and project name | ||
and service name for each compose service are automatically discovered and | ||
sent as Loki labels, this way you can filter by them in Grafana. | ||
{{% /admonition %}} | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Line 153, another note that was missed because the formatting wasn't standard. |
||
|
||
## Labels | ||
|
||
|
@@ -144,7 +150,11 @@ services: | |
- "3000:3000" | ||
``` | ||
|
||
> Note the `loki-pipeline-stages: |` allowing to keep the indentation correct. | ||
{{% admonition type="note" %}} | ||
|
||
The `loki-pipeline-stages: |` keeps the indentation correct. | ||
|
||
{{% /admonition %}} | ||
|
||
When using docker run you can also pass the value via a string parameter like such: | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think your script missed one (because it's inconsistent in the docs)
Up at line 1191 there's a deprecation note that should be changed to a warning.