arrow-left

All pages
gitbookPowered by GitBook
1 of 1

Loading...

Managing Logs

hashtag
Dynamic Log Levels

Pinot supports inspecting and modifying Log4J log levels dynamically in production environments through REST. This can often be helpful when debugging an issue that is transient in nature and restarting the server with new configurations files may alter the desired behavior.

hashtag
Supported Operations

hashtag
List All Loggers

Parameter Type
Parameter Name
Description

Sample Usage:

hashtag
Fetch Specific Logger

Parameter Type
Parameter Name
Description

Sample Usage:

hashtag
Set Logger Level

Parameter Type
Parameter Name
Description

Sample Usage

hashtag
Downloading Component Logs

Pinot supports downloading logs directly over HTTP in situations where the operator may not have access to the container, but has access to the rest endpoints.

If the operator has access to the Controller, they can download log files from any one of the other components.

hashtag
Supported Operations

hashtag
List Available Log Files

Parameter Type
Parameter Name
Description

hashtag
Download a Log File

Parameter Type
Parameter name
Description

hashtag
Remote Log APIs

circle-info

These APIs are only supported on the Controller

hashtag
List Log Files on All Instances

Parameter Type
Parameter Name
Description

hashtag
List Log Files on a Specific Instance

Parameter Type
Parameter Name
Description

hashtag
Download Remote Log From Given Instance

Parameter Type
Parameter Name
Description

Header

accept string

Setting to "accept: application/json" is recommended

Header

accept string

Setting to "accept: application/json" is recommended

Path Parameter

loggerName string

The name of the logger (fully qualified path)

Header

accept string

Setting to "accept: application/json" is recommended

Path Parameter

loggerName string

The name of the logger (fully qualified path)

Query Parameter

level string

the log level (such as DEBUG or INFO

Header

accept string

Setting to "accept: application/json" is recommended

Header

accept string

Setting to "accept: application/octet_string" is recommended

Query Parameter

filePath string

The path to the file, can be obtained using GET /loggers/files

Header

accept string

Setting to "accept": application/json" is recommended

Header

accept string

Setting to "accept": application/json" is recommended

Path Parameter

instanceName string

Indicates which instance to collect logs from

Header

accept string

Setting to "accept: application/octet

Path Parameter

instanceName string

Indicates which instance to collect logs from

Query Parameter

filePath string

Indicates which file to download

GET /loggers
$ curl -X GET -H "accept: application/json" localhost:8000/loggers
["root","org.reflections","org.apache.pinot.tools.admin"]
GET /loggers/{loggerName}
> curl -X GET -H "accept: application/json" localhost:8000/loggers/root
{"filter":null,"level":"INFO","name":"root"}
PUT /loggers/{loggerName}?level={level}
$ curl -X PUT -H "accept: application/json" localhost:8000/loggers/root?level=ERROR
{"filter":null,"level":"ERROR","name":"root"}
GET /loggers/files
GET /loggers/download?filePath={filePath}
GET /loggers/instances
GET /loggers/instances/{instanceName}
GET /loggers/instances/{instanceName}/download?filePath={filePath}