mirror of
https://github.com/clearlinux/telemetrics-client.git
synced 2026-09-06 13:41:35 +00:00
Alex Jaramillo
5cbd31cbf2
telemetrics-client installation starts when the package is installed, this change makes sure that to start telemetry the first time two steps are needed: 1- telemctl opt-in and 2- telemctl start Signed-off-by: Alex Jaramillo <alex.jch@gmail.com>
91 lines
2.7 KiB
Plaintext
91 lines
2.7 KiB
Plaintext
.\" Man page generated from reStructuredText.
|
|
.
|
|
.TH TELEMETRY 3 "" "" ""
|
|
.SH NAME
|
|
telemetry \- C programming interface for telemetrics-client
|
|
.
|
|
.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#include "telemetry.h"\fP
|
|
.sp
|
|
\fBstruct telem_ref { struct telem_record *record; };\fP
|
|
.sp
|
|
\fBint tm_create_record(struct telem_ref **t_ref, uint32_t severity, char *classification, uint32_t payload_version)\fP
|
|
.sp
|
|
\fBint tm_set_payload(struct telem_ref *t_ref, char *payload)\fP
|
|
.sp
|
|
\fBint tm_send_record(struct telem_ref *t_ref)\fP
|
|
.sp
|
|
\fBvoid tm_free_record(struct telem_ref *t_ref)\fP
|
|
.sp
|
|
\fBint tm_set_config_file(const char *c_file)\fP
|
|
.sp
|
|
\fBint tm_is_opted_in(void)\fP
|
|
.SH DESCRIPTION
|
|
.sp
|
|
The functions in the telemetry library facilitate the delivery of
|
|
telemetry data to the \fBtelemprobd\fP(1) service.
|
|
.sp
|
|
The function \fBtm_create_record()\fP initializes a telemetry record and
|
|
sets the severity and classification of that record, as well as the
|
|
payload version number. The memory needed to store the telemetry record
|
|
is allocated and should be freed with \fBtm_free_record()\fP when no longer
|
|
needed.
|
|
.sp
|
|
The function \fBtm_set_payload()\fP attaches the provided telemetry record
|
|
data to the telemetry record. The current maximum payload size is 8192b.
|
|
.sp
|
|
The function \fBtm_send_record()\fP delivers the record to the local
|
|
\fBtelemprobd\fP(1) service.
|
|
.sp
|
|
The function \fBtm_set_config_file()\fP can be used to provide an alternate
|
|
configuration path to the telemetry library.
|
|
.sp
|
|
\fBtm_is_opted_in\fP is a utility provided to check if the one time opt\-in
|
|
has been performed.
|
|
.SH RETURN VALUES
|
|
.sp
|
|
All these functions return \fB0\fP on success, or a non\-zero return value
|
|
if an error occurred. The function \fBtm_free_record()\fP does not return
|
|
any value. \fBtm_is_opted_in\fP returns \fB1\fP when telemetry is opted\-in
|
|
otherwise \fB0\fP\&.
|
|
.SH SEE ALSO
|
|
.INDENT 0.0
|
|
.IP \(bu 2
|
|
\fBtelemprobd\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.
|
|
.
|