Skip to content

Commit

Permalink
[configuration] Add information about ovos-logs
Browse files Browse the repository at this point in the history
  • Loading branch information
goldyfruit committed Jan 23, 2024
1 parent c57ce44 commit 8c0ac73
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion docs/getting-started/docker/installation/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ This configuration is very basic, it instructs the Open Voice OS instance to run

## Configure the logging

By default, the Open Voice OS [services](../../../about/glossary/components.md) will write their logs into a file under `~/.local` directory, these files are not rotated or compressed which could lead to a disk space issue.
By default, the Open Voice OS [services](../../../about/glossary/components.md) will write their logs into a file under `~/.local/state/mycroft` directory but since we are running containers, we can leverage the `docker logs` or `podman logs` commands.

The solution is to add these lines into the `~/ovos/config/mycroft.conf` file _(create the file if it does not exist)_, this will tell the services to redirect their logs to the container `stdout`.

Expand All @@ -43,6 +43,16 @@ The solution is to add these lines into the `~/ovos/config/mycroft.conf` file _(
}
```

During debug session, it might be useful to retrieve information from the different component using the `ovos-logs` command, this command is looking for log files from the `~/.local/state/mycroft` directory. If needed, then remove the following lines from the `~/ovos/config/mycroft.conf` file.

```json title="~/ovos/config/mycroft.conf"
{
"logs": {
"path": "stdout"
}
}
```

!!! note "Services already deployed"

If the services have been already deployed and the `~/ovos/config/mycroft.conf` has changed, then you will have to restart the containers impacted by the change(s).
Expand Down

0 comments on commit 8c0ac73

Please sign in to comment.