mirror of
https://github.com/clearlinux/telemetrics-client.git
synced 2026-10-03 15:41:03 +00:00
127 lines
3.5 KiB
Plaintext
127 lines
3.5 KiB
Plaintext
.\" Man page generated from reStructuredText.
|
|
.
|
|
.TH TELEMETRICS.CONF 5 "" "" ""
|
|
.SH NAME
|
|
telemetrics.conf \- Telemetry service configuration file
|
|
.
|
|
.nr rst2man-indent-level 0
|
|
.
|
|
.de1 rstReportMargin
|
|
\\$1 \\n[an-margin]
|
|
level \\n[rst2man-indent-level]
|
|
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
-
|
|
\\n[rst2man-indent0]
|
|
\\n[rst2man-indent1]
|
|
\\n[rst2man-indent2]
|
|
..
|
|
.de1 INDENT
|
|
.\" .rstReportMargin pre:
|
|
. RS \\$1
|
|
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
|
|
. nr rst2man-indent-level +1
|
|
.\" .rstReportMargin post:
|
|
..
|
|
.de UNINDENT
|
|
. RE
|
|
.\" indent \\n[an-margin]
|
|
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
.nr rst2man-indent-level -1
|
|
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
|
..
|
|
.SH SYNOPSIS
|
|
.sp
|
|
\fB/etc/telemetrics/telemetrics.conf\fP
|
|
.sp
|
|
\fB/usr/share/defaults/telemetrics/telemetrics.conf\fP
|
|
.SH DESCRIPTION
|
|
.sp
|
|
This file contains configuration parameters for the \fBtelemd\fP(1) telemetry
|
|
service daemon. The daemon reads this file at startup if it exists.
|
|
.SH SYNTAX
|
|
.sp
|
|
The configuration file contains \fBkey=value\fP pairs, formatted as plain
|
|
text, one option per line. Comments can be added by preceding them with the
|
|
\fB#\fP character. All configuration options should be in a section marked
|
|
with \fB[settings]\fP\&.
|
|
.SH OPTIONS
|
|
.INDENT 0.0
|
|
.IP \(bu 2
|
|
\fBserver=<url>\fP
|
|
.sp
|
|
Server URL including protocol designator.
|
|
.IP \(bu 2
|
|
\fBsocket_path=<path>\fP
|
|
.sp
|
|
Path to the socket that \fItelemd\fP will listen on.
|
|
.IP \(bu 2
|
|
\fBcainfo=<path>\fP
|
|
.sp
|
|
Certificate file to use for validation of SSL endpoint.
|
|
.IP \(bu 2
|
|
\fBtidheader=<header>\fP
|
|
.sp
|
|
Telemetry ID in header format, usually \fBtidheader=X\-Telemetry\-TID:<uuid>\fP
|
|
post header used to group records in ingestion service, which may be
|
|
ingesting for more than one set of clients. Can be set to any string.
|
|
.IP \(bu 2
|
|
\fBrecord_expiry=<minutes>\fP
|
|
.sp
|
|
Record expiry time in minutes.
|
|
.IP \(bu 2
|
|
\fBspool_dir=<dir>\fP
|
|
.sp
|
|
Local spool directory used to store records being processed.
|
|
.IP \(bu 2
|
|
\fBspool_max_size=<kB>\fP
|
|
.sp
|
|
maximum size of the spool directory in kB. A value of \fB\-1\fP indicates
|
|
no limit. The block size of the files in this directory is considered,
|
|
and not the actual size of the record itself.
|
|
.IP \(bu 2
|
|
\fBspool_process_time=<seconds>\fP
|
|
.sp
|
|
Time in seconds for processing spool. Valid range: 120..3600. Values
|
|
outside this range are clamped.
|
|
.IP \(bu 2
|
|
\fBrate_limit_enabled=<true|false>\fP
|
|
.sp
|
|
Enable rate limiting. If this is set to false then all rate\-limiting
|
|
disabled. It is possible to disable each rate\-limit individually below.
|
|
.IP \(bu 2
|
|
\fBrecord_burst_limit=<limit>\fP
|
|
.sp
|
|
Rate limiting record burst limit. Valid Range: 0..\(ga\(gaINT_MAX\(ga\(ga, \-1 = disabled.
|
|
.IP \(bu 2
|
|
\fBrecord_window_length=<minutes>\fP
|
|
.sp
|
|
Rate limiting record window length in minutes. Valid Range: 0..59.
|
|
.IP \(bu 2
|
|
\fBbyte_burst_limit=<limit>\fP
|
|
.sp
|
|
Rate limiting byte burst limit. Valid Range: 0..\(gaINT_MAX\(ga, \-1 = disabled.
|
|
.IP \(bu 2
|
|
\fBbyte_window_length=<minutes>\fP
|
|
.sp
|
|
Rate limiting byte window length in minutes. Valid Range: 0..59.
|
|
.IP \(bu 2
|
|
\fBrate_limit_strategy=<strategy>\fP
|
|
.sp
|
|
Rate limit strategy \- what to do with record if rate\-limiting prevents
|
|
delivery over network. Valid stategies: \fBspool\fP, \fBdrop\fP\&.
|
|
.UNINDENT
|
|
.SH SEE ALSO
|
|
.INDENT 0.0
|
|
.IP \(bu 2
|
|
\fBtelemd\fP(1)
|
|
.IP \(bu 2
|
|
\fI\%https://github.com/clearlinux/telemetrics\-client\fP
|
|
.IP \(bu 2
|
|
\fI\%https://clearlinux.org/documentation/\fP
|
|
.UNINDENT
|
|
.SH COPYRIGHT
|
|
(C) 2017 Intel Corporation, CC-BY-SA-3.0
|
|
.\" Generated by docutils manpage writer.
|
|
.
|