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.

Sign up for GitHub

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

DOCS-1676: Add fine-grained logging controls #3718

Merged
merged 1 commit into from
Dec 2, 2024
Merged

DOCS-1676: Add fine-grained logging controls #3718

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
51 changes: 40 additions & 11 deletions docs/architecture/viam-server.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,12 +100,48 @@ maintenance : {

### Logging

Log messages written appear under the [**LOGS** tab](/cloud/machines/#logs) for the machine running the module.

#### Debugging
Log messages appear under the [**LOGS** tab](/cloud/machines/#logs) for a machine.

The default log level for `viam-server` and any running resources is `"Info"`.

You can set log levels for individual resources by adding the `log_configuration` option to the resources' JSON configuration:

```json
"log_configuration": {
"level": "Debug"
},
"attributes": { ... }
```

Alternatively, you can configure logs for all machine resources, inside your machine config.
To specify the log level for a specific resource, add the `log` field to your machine config:

For example:

```json
"log": [
     {
       "pattern": "rdk.resource_manager",
       "level": "info",
     },{
       "pattern": "rdk.resource_manager.*",
       "level": "debug",
     }
  ]
```

<!-- prettier-ignore -->
| Attribute | Description |
| --------- | ----------- |
| `pattern` | A regular expression (regex) pattern matching one or more resources. |
| `level` | The log level: `"debug"`, `"info"`, `"warn"`, or `"error"`. |

Patterns are processed from top to bottom.
If multiple patterns apply, the last pattern to be processed will apply.
If log configurations are applied at a resource level using the `log_configuration` field, these take precedence over log levels applied in the `log` field of the machine configuration.

#### Debugging

You can enable debug level logs in two ways:

- Start `viam-server` with the `-debug` option.
Expand All @@ -118,14 +154,7 @@ You can enable debug level logs in two ways:
}
```

To enable debug level logs for specific resources you can add the `log_configuration` option to the resources' JSON configuration:

```json
"log_configuration": {
"level": "Debug"
},
"attributes": { ... }
```
Enabling debug level logs will take precedence over all logging configuration set using the `log` field on a machine or the `log_configuration` field on a resource.

### Shutdown

Expand Down
Loading