Skip to content

Commit 6188d7e

Browse files
authored
Add files via upload
Added the doc for the new container logging capability
1 parent 2867feb commit 6188d7e

1 file changed

Lines changed: 27 additions & 0 deletions

File tree

docs/log-support.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Support for container logging
2+
3+
Now, you can enable logging on NetScaler Observability Exporter according to different severity levels. These logs help in getting information about endpoint specific configuration.
4+
5+
The following logging severity levels are supported and the default value is `INFO`.
6+
7+
- `NONE` : None of the messages are logged.
8+
- `FATAL` : Only fatal messages are logged.
9+
- `ERROR`: Only fatal messages and error messages are logged.
10+
- `INFO`: Only fatal, error, and informational messages are logged.
11+
12+
For Kubernetes YAML based deployments the default value is NONE. But, for Helm and OpenShift operator deployments of NetScaler Observability Exporter logging is enabled by default and set as INFO.
13+
14+
You can configure logging using the environment variable `NSOE_LOG_LEVEL` while deploying NetScaler Observability Exporter for each endpoint.
15+
16+
The following example shows how to configure the log level in the NetScaler Observability Exporter deployment YAML:
17+
18+
env:
19+
- name: NSOE_LOG_LEVEL
20+
value: "INFO"
21+
22+
The following are the types of logs that you can get:
23+
24+
- NetScaler Observability Exporter configuration file errors and parsing errors.
25+
- Endpoint (ElasticSearch, Splunk) status such as up or down.
26+
- Endpoint specific configuration errors. For example, the message saying `Kafka topic is invalid`.
27+
- NetScaler related configuration messages. For example, adding or deleting a NetScaler IP address.

0 commit comments

Comments
 (0)