Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

header-navigation
keyboard_arrow_up
list Table of Contents
file_download PDF
{ "lLangCode": "en", "lName": "English", "lCountryCode": "us", "transcode": "en_US" }
English
keyboard_arrow_right

Configure Sources and Sinks

date_range 17-Dec-24

To set up monitoring, you must configure Paragon Automation to specify sources and destinations for the metrics. The following terms are used extensively in this topic:

  • Source—A source is the type and origin from which the observability data is collected.

  • Sink—A sink is the destination to which the collected and transformed data is sent. This data can be visualized, interpreted, and analyzed to gain insights into cluster resource usage and performance, service status, and logs.

General Configuration Overview

Configure sources and sinks from the Paragon Shell CLI configuration mode. To enter configuration mode, type configure in Paragon Shell.

content_copy zoom_out_map
root@node> configure
Entering configuration mode
[edit]
root@node#

To configure a source, use the following command:

content_copy zoom_out_map
user@node# set paragon monitoring source source_id scope source_type

Where:

  • source_id—Used to index the source and specified by the user.

  • scope —Specifies whether the metrics must be collected at the cluster level or at the node level.

  • source_type—See Supported Node Sources for a list of supported source types.

Similarly, to configure a sink, use the following command:

content_copy zoom_out_map
user@node# set paragon monitoring sink sink_id sink_type

Where:

  • sink_id—Used to index the sink and specified by the user.

  • source_type—See Supported Sinks for a list of supported sink types.

To configure a sink to receive data from one or more sources, use the inputs keyword.

content_copy zoom_out_map
user@node# set paragon monitoring sink sink_id inputs (source_id|list of source_ids)

Where, the input entries must match the defined source_ids.

Majority of sources and sinks have their own options. Type ? after source_type or sink_type to view all available options.

content_copy zoom_out_map
user@node# set paragon monitoring source source_id scope source_type ?

or

content_copy zoom_out_map
user@node# set paragon monitoring sink sink_id sink_type ?

Vector.dev, by default, supports a reservoir of different types of sources and sinks. Currently, a few major sources are integrated into Paragon Shell CLI. Refer to Sample Sources and Sinks Configuration for detailed configuration for each currently supported sources and sinks.

footer-navigation