From 0f56a2c760ebab83f6c91048d95ab7b81f381072 Mon Sep 17 00:00:00 2001 From: ananalaghbar <79898567+ananalaghbar@users.noreply.github.com> Date: Tue, 8 Oct 2024 11:13:42 +0300 Subject: [PATCH] issue:4098913: [TFS Plugin]: Update the README with the latest changes for the XDR and fallback option when the telemetry is down (#265) --- plugins/fluentd_telemetry_plugin/README.md | 58 ++++++++++++++-------- 1 file changed, 38 insertions(+), 20 deletions(-) diff --git a/plugins/fluentd_telemetry_plugin/README.md b/plugins/fluentd_telemetry_plugin/README.md index 6dfe9d208..66d7f5844 100644 --- a/plugins/fluentd_telemetry_plugin/README.md +++ b/plugins/fluentd_telemetry_plugin/README.md @@ -192,24 +192,28 @@ Usage -| Parameter | Required | Description | -|:--------------------------------------------------------------------------------:|:--------:|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| -| [fluentd-endpoint.host](conf/fluentd_telemetry_plugin.cfg#L7) | True | Hostname or IPv4 or IPv6 for Fluentd endpoint | -| [fluentd-endpoint.port](conf/fluentd_telemetry_plugin.cfg#L8) | True | Port for Fluentd endpoint [this port should be the port which is configured in [fluentd.conf](conf/fluentd.conf#L4)] | -| [fluentd-endpoint.timeout](conf/fluentd_telemetry_plugin.cfg#L9) | True | Timeout for Fluentd endpoint streaming [Default is 120 seconds] | -| [ufm-telemetry-endpoint.host](conf/fluentd_telemetry_plugin.cfg#L2) | True | Hostname or IPv4 or IPv6 for The UFM Telemetry Endpoint [Default is 127.0.0.1] | -| [ufm-telemetry-endpoint.port](conf/fluentd_telemetry_plugin.cfg#L3) | True | Port for The UFM Telemetry Endpoint [Default is 9001] | -| [ufm-telemetry-endpoint.url](conf/fluentd_telemetry_plugin.cfg#L4) | True | URL for The UFM Telemetry Endpoint [Default is 'csv/metrics', for Prometheus format you can use 'metrics'] | -| [ufm-telemetry-endpoint.interval](conf/fluentd_telemetry_plugin.cfg#L13) | True | Streaming interval [Default is 30 seconds] | -| [ufm-telemetry-endpoint.message_tag_name](conf/fluentd_telemetry_plugin.cfg#L10) | False | Message Tag Name for Fluentd endpoint message [Default is the ufm-telemetry-endpoint.host:ufm-telemetry-endpoint.port] | -| [streaming.bulk_streaming](conf/fluentd_telemetry_plugin.cfg#L14) | True | if True all telemetry records will be streamed in one message; otherwise, each record will be streamed in a separated message [Default is True] | -| [streaming.compressed_streaming](conf/fluentd_telemetry_plugin.cfg#L15) | True | if True, the streamed data will be sent gzipped json and you have to make sure to configure the FluentD receiver with the right configurations (Check the FluentdD Deployment configurations section); otherwise, the message will be sent plain text as json [Default is False] | -| [streaming.stream_only_new_samples](conf/fluentd_telemetry_plugin.cfg#L16) | True | If True, the plugin will stream only the changed values [Default is True] | -| [streaming.enabled](conf/fluentd_telemetry_plugin.cfg#L17) | True | If True, the streaming will be started once the required configurations have been set [Default is False] | -| [logs-config.logs_file_name](conf/fluentd_telemetry_plugin.cfg#L20) | True | Log file name [Default = '/log/tfs.log'] | -| [logs-config.logs_level](conf/fluentd_telemetry_plugin.cfg#L22) | True | Default is 'INFO' | -| [logs-config.max_log_file_size](conf/fluentd_telemetry_plugin.cfg#L24) | True | Maximum log file size in Bytes [Default is 10 MB] | -| [logs-config.log_file_backup_count](conf/fluentd_telemetry_plugin.cfg#L26) | True | Maximum number of backup log files [Default is 5] | +| Parameter | Required | Description | Default | +|:-----------------------------------------------------------------------------------------:|:--------:|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------:| +| [fluentd-endpoint.host](conf/fluentd_telemetry_plugin.cfg#L7) | True | Hostname or IPv4 or IPv6 for Fluentd endpoint | | +| [fluentd-endpoint.port](conf/fluentd_telemetry_plugin.cfg#L8) | True | Port for Fluentd endpoint [this port should be the port which is configured in [fluentd.conf](conf/fluentd.conf#L4)] | 24225 | +| [fluentd-endpoint.timeout](conf/fluentd_telemetry_plugin.cfg#L9) | True | Timeout in seconds for Fluentd endpoint streaming | 120 | +| [ufm-telemetry-endpoint.host](conf/fluentd_telemetry_plugin.cfg#L2) | True | Hostname or IPv4 or IPv6 for The UFM Telemetry Endpoint | 127.0.0.1 | +| [ufm-telemetry-endpoint.port](conf/fluentd_telemetry_plugin.cfg#L3) | True | Port for The UFM Telemetry Endpoint | 9001 | +| [ufm-telemetry-endpoint.url](conf/fluentd_telemetry_plugin.cfg#L4) | True | URL for The UFM Telemetry Endpoint, for Prometheus format you can use 'metrics' | 'csv/metrics' | +| [ufm-telemetry-endpoint.interval](conf/fluentd_telemetry_plugin.cfg#L13) | True | Streaming interval in seconds | 30 | +| [ufm-telemetry-endpoint.message_tag_name](conf/fluentd_telemetry_plugin.cfg#L10) | False | Message Tag Name for Fluentd endpoint message | ufm-telemetry-endpoint.host:ufm-telemetry-endpoint.port | +| [ufm-telemetry-endpoint.xdr_mode](conf/fluentd_telemetry_plugin.cfg#7) | True | If True for a specific UFM telemetry endpoint, the TFS will start collecting/streaming the configured ports types specified under “xdr_ports_types” | False | +| [ufm-telemetry-endpoint.xdr_ports_types](conf/fluentd_telemetry_plugin.cfg#8) | True | List of XDR port types that the TFS should collect and stream from a specified UFM telemetry endpoint | 'legacy', 'plane', 'aggregated' | +| [streaming.bulk_streaming](conf/fluentd_telemetry_plugin.cfg#L14) | True | if True all telemetry records will be streamed in one message; otherwise, each record will be streamed in a separated message | True | +| [streaming.compressed_streaming](conf/fluentd_telemetry_plugin.cfg#L15) | True | if True, the streamed data will be sent gzipped json and you have to make sure to configure the FluentD receiver with the right configurations; otherwise, the message will be sent plain text as json | False | +| [streaming.stream_only_new_samples](conf/fluentd_telemetry_plugin.cfg#L16) | True | If True, the plugin will stream only the changed values | True | +| [streaming.enabled](conf/fluentd_telemetry_plugin.cfg#L17) | True | If True, the streaming will be started once the required configurations have been set | False | +| [streaming.enable_cached_stream_on_telemetry_fail](conf/fluentd_telemetry_plugin.cfg#L20) | True | If True, it will enable the fallback option to stream cached data from the last successful iteration when the telemetry endpoint is unavailable. | True | +| [logs-config.logs_file_name](conf/fluentd_telemetry_plugin.cfg#L20) | True | Log file name | /log/tfs.log | +| [logs-config.logs_level](conf/fluentd_telemetry_plugin.cfg#L22) | True | Logs severity level | INFO | +| [logs-config.max_log_file_size](conf/fluentd_telemetry_plugin.cfg#L24) | True | Maximum log file size in Bytes | 10 MB | +| [logs-config.log_file_backup_count](conf/fluentd_telemetry_plugin.cfg#L26) | True | Maximum number of backup log files | 5 | + @@ -257,7 +261,13 @@ curl --location 'https:///ufmRest/plugin/tfs/conf' \ "url": "csv/metrics", "port": 9001, "interval": 30, - "message_tag_name": "high_freq_endpoint" + "message_tag_name": "high_freq_endpoint", + "xdr_mode": false, + "xdr_ports_types": [ + "legacy", + "aggregated", + "plane" + ] }], "fluentd-endpoint": { "host": "10.209.36.68", @@ -266,6 +276,7 @@ curl --location 'https:///ufmRest/plugin/tfs/conf' \ "streaming": { "compressed_streaming": false, "bulk_streaming": true, + "enable_cached_stream_on_telemetry_fail": true, "enabled": true, "stream_only_new_samples": true }, @@ -310,7 +321,13 @@ Response Example: "url": "csv/metrics", "port": 9001, "interval": 30, - "message_tag_name": "high_freq_endpoint" + "message_tag_name": "high_freq_endpoint", + "xdr_mode": false, + "xdr_ports_types": [ + "legacy", + "aggregated", + "plane" + ] }], "fluentd-endpoint": { "host": "10.209.36.68", @@ -320,6 +337,7 @@ Response Example: "compressed_streaming": false, "bulk_streaming": true, "enabled": true, + "enable_cached_stream_on_telemetry_fail": true, "stream_only_new_samples": true }, "logs-config": {