Skip to content

Commit 9d38571

Browse files
authored
Update logging.mdx
1 parent ca3fce2 commit 9d38571

File tree

1 file changed

+10
-13
lines changed

1 file changed

+10
-13
lines changed

vcluster/configure/vcluster-yaml/logging.mdx

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,21 +8,21 @@ description: Configuration for setting structured logging options for vCluster.
88
import InterpolatedCodeBlock from '@site/src/components/InterpolatedCodeBlock'
99
import Logging from '../../_partials/config/logging.mdx'
1010

11-
By default, vCluster creates logs in the control plane pod in console format, which is easy to read and preferred for manual log review. However, you can configure the logging in the control plane pod to JSON format. By enabling the JSON format, logs can be sent to external tools to aggregate logs across multiple virtual clusters to help monitor and troubleshoot these virtual clusters.
11+
By default, vCluster generates logs in console format. Console format provides human-readable output that is well-suited for manual log review and troubleshooting. Alternatively, you can configure vCluster to output logs in JSON format. JSON format enables integration with external logging systems for centralized log aggregation and automated monitoring across multiple virtual clusters.
1212

1313
## Log encoding formats
1414

1515
vCluster supports two log encoding formats for the vCluster control plane pod.
1616

17-
- console (_Default_): Human-readable format. Ideal for development and manual log review.
18-
- JSON: Structured format for log aggregation. Ideal for external monitoring and analysis tools.
17+
- [console](#console-format) (_Default_): Human-readable format. Ideal for development and manual log review.
18+
- [JSON](#json-format): Structured format for log aggregation. Ideal for external monitoring and analysis tools.
1919

2020
### Console format
2121

22-
The console format provides human-readable logs with timestamps, log levels, source locations, and contextual information. The console format is best suited for use cases where users will be troubleshooting a single virtual cluster. Choose this format in environments where human readability is more important than structured log parsing. Example use cases include:
22+
The console format provides human-readable logs with timestamps, log levels, source locations, and contextual information. This format works well for use cases where users are troubleshooting a single virtual cluster. Choose this format in environments where human readability is more important than structured log parsing. Example use cases include:
2323

24-
* Local development and testing, where developers benefit from quick, readable output
25-
* Single virtual cluster analysis, where users will manually review logs and debug in a terminal
24+
- Local development and testing, where developers benefit from quick, readable output
25+
- Single virtual cluster analysis, where users manually review logs and debug in a terminal
2626

2727
```text
2828
2025-06-16 04:43:25 INFO license loader/inject.go:52 initializing license... {"component": "vcluster"}
@@ -32,10 +32,9 @@ The console format provides human-readable logs with timestamps, log levels, sou
3232
```
3333

3434
### JSON format
35+
The JSON format structures log data for programmatic processing and integration with log management systems. This format is best suited for use cases where external tools monitor and analyze logs for multiple virtual clusters. Log aggregation tools (for example, Elasticsearch or Splunk) can ingest these logs to support automated analysis, alerting, and integration with monitoring platforms (for example, Prometheus and Grafana). Example use cases include:
3536

36-
The JSON format structures log data for programmatic processing and integration with log management systems. The JSON format is best suited for use cases where external tools are used to monitor and analyze logs for multiple virtual clusters. Log aggregation tools (e.g. Elasticsearch or Splunk) can ingest these logs to support automated analysis, alerting, and integration with monitoring platforms (e.g. Prometheus and Grafana). Examples use cases include:
37-
38-
* Product environments where multiple virtual clusters are being monitored and logs from all of them need to be parsed and processed automatically.
37+
- Production environments where you monitor multiple virtual clusters and require automatic parsing and processing of logs
3938

4039
```json
4140
{"level":"info","ts":1750160027.442782,"logger":"license","caller":"loader/inject.go:52","msg":"initializing license...","component":"vcluster"}
@@ -60,9 +59,7 @@ Additional fields might be displayed based on context and log content.
6059

6160
## Enable log encoding
6261

63-
Logging is enabled in your `vcluster.yaml` configuration file.
64-
65-
62+
Configure logging in your `vcluster.yaml` configuration file.
6663

6764
You can enable the JSON format of log encoding.
6865

@@ -79,7 +76,7 @@ logging:
7976
```
8077

8178
:::note
82-
When changing between encoding formats, the pod will be restarted and all previous logs will be lost.
79+
When changing between encoding formats, the pod restarts and all previous logs are lost.
8380
:::
8481

8582
## Config reference

0 commit comments

Comments
 (0)