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

Document how to get logs #2355

Merged
merged 10 commits into from
Apr 5, 2023
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
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
23 changes: 23 additions & 0 deletions website/docs/logs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
sidebar_position: 10
description: Logs
---

# Logging

## Docker logs

Logs from FerretDB running on Docker can be accessed through the container.

If Docker was launched with the [quick start](quickstart-guide/docker.md#setup-with-docker-compose),
the following command can be used to fetch the logs.

```shell
docker logs -name ferretdb-docker-ferretdb-1
```

## Binary executable logs

FerretDB generates logs to standard output `stdout` and standard error `stderr` streams
but does not retain them.
Refer to the [flags](configuration/flags.md#miscellaneous) to adjust the log level.
4 changes: 4 additions & 0 deletions website/docs/quickstart-guide/deb.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,7 @@ $ sudo apt install ./<filename>.deb

Once FerretDB is installed, you can start the software.
See [our Docker guide](docker.md) and [Configuration flags and variables](../configuration/flags.md) page for more details.

Find out more about:

* [Getting logs](../logs.md#binary-executable-logs)
4 changes: 4 additions & 0 deletions website/docs/quickstart-guide/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,3 +78,7 @@ You can improve that setup by:

* [securing connections with TLS](../security.md#securing-connections-with-tls);
* adding backups.

Find out more about:

* [Getting logs](../logs.md#docker-logs)