Skip to content

Add log level configuration instruction #21

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

Merged
erdii merged 1 commit into from
Jun 5, 2025
Merged

Add log level configuration instruction #21

Show file tree
Hide file tree
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
4 changes: 3 additions & 1 deletion content/en/docs/concepts/monitoring.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@ Package Operator exports metrics on the `/metrics` endpoint which can be used
to monitor PKO and packages. These are exported by the
`package-operator-manager` pod. In order to monitor PKO a monitoring
stack including Prometheus is required.
This example will assume you have [Prometheus Operator](<https://github.com/prometheus-operator/prometheus-operator>) installed.
This example will assume you have
[Prometheus Operator](<https://github.com/prometheus-operator/prometheus-operator>)
installed.

## RBAC

Expand Down
31 changes: 30 additions & 1 deletion content/en/docs/concepts/package-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -595,7 +595,36 @@ Example `manifest.yaml`:
These steps guided you through deploying and updating your application using package
configuration and ClusterObjectTemplates with the Package Operator.

## Error Messages and Troubleshooting
## Troubleshooting

### Logging Behavior

The `logLevel` configuration helps you control the verbosity of logs to aid in troubleshooting.

To increase verbosity for troubleshooting,
update the `logLevel` via the `spec.config` field of your `ClusterPackage`.
For example:

```bash
kubectl patch clusterpackage package-operator \
--type=merge \
-p '{"spec": {"config": {"logLevel": 1}}}'
```

**Log Level Reference:**

| `logLevel` | Output Includes |
|------------|----------------------------------------------------------------------------------|
| `-1` | `log.Error()` – Default level; errors logs shown. |
| `0` | `log.Error()` and `log.Info()` – Base level of informational logs. |
| `1` | `log.Error()`, `log.Info()`, and `log.V(1).Info()` – Adds first level of debug. |
| `2` | Above plus `log.V(2).Info()` – includes second-level debug logs. |
| ... | Increasing verbosity with higher numbers – adds `log.V(N).Info()` for N ≥ 3. |

This setting is helpful when debugging reconciliation behavior,
unexpected resource changes, or communication issues across clusters.

### Error Messages and Troubleshooting

During the package configuration process, you may encounter common
errors such as missing or incorrectly formatted values. Here are some
Expand Down