o
G%@iT @ s^ d dl mZ d dlmZmZmZ d dlmZmZmZ d dl m
Z
m Z m Z G dd de
e Z
dS ) )Optional)datetime timedeltatimezone)JSONDecodeErrordumpsloads)PluginIndependentPlugin PluginOptc
@ s e Zd ZdZdZdZdZdZdZdZ e
dd d
d e
d d d
d e
dd dd e
dde dde
dde ddgZ de
e de
e fddZde
e de
e fdd Zd d Zd d Zd!d" Zd#d$ Zd%d& Zd'S )(Lokia
Collects logs and configuration from Loki.
This plugin interacts with the Loki API to fetch logs based on specified
labels and provides options for pagination and label detection.
It also collects relevant configuration files and masks sensitive
information. It works with both charmed and non-charmed Loki.
To fetch internal Loki logs, run it from the Loki container.
You can also run it from another machine and fetch only logs from
Loki API, by providing the following parameters:
`-k loki.collect-logs=true -k loki.endpoint=LOKI_URL`
Usage:
sos report -o loki -k loki.collect-logs=true -k loki.labels=severity:charm -k loki.detect-labels=true -k loki.paginate=true -k loki.endpoint=LOKI_URL
z Loki serviceloki)servicesi d )r
collect-logsFzcollect logs from Loki API)defaultdesc
detect-labelszTfetch logs for all available labels. May result in multiple files with the same logspaginatez'fetch all available logs from Loki API.labels z1colon-delimited list of labels to fetch logs from)r val_typer endpointhttp://localhost:3100zDloki endpoint to fetch logs from. Defaults to http://localhost:3100.startendc C s` |st tj}|s|tdd }|d}|d}d| d| d| d| dtj d }|S )
N )daysz%Y-%m-%dT%H:%M:%S.%fZ curl -G -s 'z3/loki/api/v1/query_range' --data-urlencode 'query={z!=~".+"}' --data-urlencode 'start=z' --data-urlencode 'end=z' --data-urlencode 'limit=z' )r nowr utcr strftimer LOKI_QUERY_LIMIT)selfr labelr r start_formatted
end_formattedcommand r( 9/usr/lib/python3/dist-packages/sos/report/plugins/loki.py
query_command< s"
zLoki.query_commandc C sR | | ||||}zt|d W S ty( | d| d |d Y S w )Noutputz-An error was returned from Loki API on label z-. Error message stored, not querying further.)exec_cmdr* r r _log_warn)r# r r$ r r r+ r( r( r) get_logsO s
z
Loki.get_logsc C sR |d d }t t d }|D ]}|d D ]
}t |d }t||}qq|S )Ndataresult ʚ;valuesr )intr r timestampmin)r# logs log_streams earliest_logstreamlogr4 r( r( r) get_earliest_log_timestamp[ s z Loki.get_earliest_log_timestampc C sF | ||d d }| | d}|t|dd W d n1 s$w Y t|tr0d S |r| |}tt
d }d}|t j k r||k rt
|d } | ||d | }
| | d| }|t|
dd W d n1 syw Y t|
trd S |}| |
}|d7 }|t j k r||k sLd S d S d S d S d S )Nz.log )indentr1 r z.log.r )r. collection_filewriter
isinstancestrr; r3 r r r4 r MAX_PAGINATION_ITERATIONS
fromtimestamp) r# r r$ r r6 logfiler8 previous_earliest_logiterations_count
log_timestampnew_logsr( r( r) get_logs_for_labele sD
zLoki.get_logs_for_labelc C s | d}| | | d}| | | d | d | drb| dp)d}g | _| d }rDt|trD|rD| j|d | d
rd| d | d }t
|d
}| j|d d S d S d S )Nz/etc/loki/*.yamlz/etc/worker/*.yamlz/var/log/loki/*zpebble logs loki -n 10000r r r r :r r z/loki/api/v1/labels'r+ r/ ) path_join
add_copy_specadd_cmd_output
get_optionr r@ rA extendsplitcollect_cmd_outputr )r# els_config_file coordinated_workers_config_filer
labels_option
labels_cmd labels_jsonr( r( r) setup s(
z
Loki.setupc C s6 | dpd}| jD ]}| d}| ||| q
d S )Nr r r )rN r rI )r# r r$ r r( r( r) collect s
z Loki.collectc C s^ ddg}g d}dd | d}dd | d}|D ]}| ||d | ||d q d S ) N
access_key_idsecret_access_key)z /etc/loki/loki-local-config.yamlz/etc/loki/config.yamlz/etc/loki/local-config.yamlz/etc/loki/loki.yamlz/etc/worker/config.yaml(|z)\s*(:|=)(\S*\n.*?\\n)z)\s*(:|=)\s*[a-zA-Z0-9]*z
\1\2*********)join do_file_sub)r# protect_keys
loki_filesmatch_exp_multil match_expfiler( r( r) postproc s z
Loki.postprocN)__name__
__module__ __qualname____doc__
short_desc plugin_nameprofilesr" rB packagesr rA option_listr r r* r. r; rI rW rX rd r( r( r( r) r sF
r N)typingr r r r jsonr r r sos.report.pluginsr r
r r r( r( r( r)