From 0c1a5001421368b9ee125310d3bf69a97e4b8c2e Mon Sep 17 00:00:00 2001 From: Srikanth Chekuri Date: Thu, 18 Jan 2024 20:02:25 +0530 Subject: [PATCH] chore: update onboarding docs to send logs from the end with a note for about beginning (#4374) --- .../ApplicationLogs/applicationLogsFromLogFile.md | 6 ++++-- .../appplicationLogs-linuxamd64-configureReceiver.md | 4 +++- .../appplicationLogs-linuxarm64-configureReceiver.md | 4 +++- .../appplicationLogs-macosamd64-configureReceiver.md | 4 +++- .../appplicationLogs-macosarm64-configureReceiver.md | 4 +++- 5 files changed, 16 insertions(+), 6 deletions(-) diff --git a/frontend/src/container/OnboardingContainer/Modules/LogsManagement/ApplicationLogs/applicationLogsFromLogFile.md b/frontend/src/container/OnboardingContainer/Modules/LogsManagement/ApplicationLogs/applicationLogsFromLogFile.md index d444b5ef41..cb9c6ed938 100644 --- a/frontend/src/container/OnboardingContainer/Modules/LogsManagement/ApplicationLogs/applicationLogsFromLogFile.md +++ b/frontend/src/container/OnboardingContainer/Modules/LogsManagement/ApplicationLogs/applicationLogsFromLogFile.md @@ -9,11 +9,13 @@ ... filelog/app: include: [ /tmp/app.log ] - start_at: beginning + start_at: end ... ``` - `start_at: beginning` can be removed once you are done testing. + Replace `/tmp/app.log` with the path to your log file. + + Note: change the `start_at` value to `beginning` if you want to read the log file from the beginning. It may be useful if you want to send old logs to SigNoz. The log records older than the standard log retention period (default 15 days) will be discarded. For parsing logs of different formats you will have to use operators, you can read more about operators [here](https://signoz.io/docs/userguide/logs/#operators-for-parsing-and-manipulating-logs). diff --git a/frontend/src/container/OnboardingContainer/Modules/LogsManagement/ApplicationLogs/md-docs/LinuxAMD64/appplicationLogs-linuxamd64-configureReceiver.md b/frontend/src/container/OnboardingContainer/Modules/LogsManagement/ApplicationLogs/md-docs/LinuxAMD64/appplicationLogs-linuxamd64-configureReceiver.md index 3513628a86..2b2d346f3a 100644 --- a/frontend/src/container/OnboardingContainer/Modules/LogsManagement/ApplicationLogs/md-docs/LinuxAMD64/appplicationLogs-linuxamd64-configureReceiver.md +++ b/frontend/src/container/OnboardingContainer/Modules/LogsManagement/ApplicationLogs/md-docs/LinuxAMD64/appplicationLogs-linuxamd64-configureReceiver.md @@ -7,11 +7,13 @@ receivers: ... filelog/app: include: [ /tmp/app.log ] - start_at: beginning + start_at: end ... ``` Replace `/tmp/app.log` with the path to your log file. +Note: change the `start_at` value to `beginning` if you want to read the log file from the beginning. It may be useful if you want to send old logs to SigNoz. The log records older than the standard log retention period (default 15 days) will be discarded. + For more configurations that are available for syslog receiver please check [here](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/filelogreceiver). ### Step 2: Include filelog receiver in the Pipeline diff --git a/frontend/src/container/OnboardingContainer/Modules/LogsManagement/ApplicationLogs/md-docs/LinuxARM64/appplicationLogs-linuxarm64-configureReceiver.md b/frontend/src/container/OnboardingContainer/Modules/LogsManagement/ApplicationLogs/md-docs/LinuxARM64/appplicationLogs-linuxarm64-configureReceiver.md index 3513628a86..2b2d346f3a 100644 --- a/frontend/src/container/OnboardingContainer/Modules/LogsManagement/ApplicationLogs/md-docs/LinuxARM64/appplicationLogs-linuxarm64-configureReceiver.md +++ b/frontend/src/container/OnboardingContainer/Modules/LogsManagement/ApplicationLogs/md-docs/LinuxARM64/appplicationLogs-linuxarm64-configureReceiver.md @@ -7,11 +7,13 @@ receivers: ... filelog/app: include: [ /tmp/app.log ] - start_at: beginning + start_at: end ... ``` Replace `/tmp/app.log` with the path to your log file. +Note: change the `start_at` value to `beginning` if you want to read the log file from the beginning. It may be useful if you want to send old logs to SigNoz. The log records older than the standard log retention period (default 15 days) will be discarded. + For more configurations that are available for syslog receiver please check [here](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/filelogreceiver). ### Step 2: Include filelog receiver in the Pipeline diff --git a/frontend/src/container/OnboardingContainer/Modules/LogsManagement/ApplicationLogs/md-docs/MacOsAMD64/appplicationLogs-macosamd64-configureReceiver.md b/frontend/src/container/OnboardingContainer/Modules/LogsManagement/ApplicationLogs/md-docs/MacOsAMD64/appplicationLogs-macosamd64-configureReceiver.md index 3513628a86..2b2d346f3a 100644 --- a/frontend/src/container/OnboardingContainer/Modules/LogsManagement/ApplicationLogs/md-docs/MacOsAMD64/appplicationLogs-macosamd64-configureReceiver.md +++ b/frontend/src/container/OnboardingContainer/Modules/LogsManagement/ApplicationLogs/md-docs/MacOsAMD64/appplicationLogs-macosamd64-configureReceiver.md @@ -7,11 +7,13 @@ receivers: ... filelog/app: include: [ /tmp/app.log ] - start_at: beginning + start_at: end ... ``` Replace `/tmp/app.log` with the path to your log file. +Note: change the `start_at` value to `beginning` if you want to read the log file from the beginning. It may be useful if you want to send old logs to SigNoz. The log records older than the standard log retention period (default 15 days) will be discarded. + For more configurations that are available for syslog receiver please check [here](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/filelogreceiver). ### Step 2: Include filelog receiver in the Pipeline diff --git a/frontend/src/container/OnboardingContainer/Modules/LogsManagement/ApplicationLogs/md-docs/MacOsARM64/appplicationLogs-macosarm64-configureReceiver.md b/frontend/src/container/OnboardingContainer/Modules/LogsManagement/ApplicationLogs/md-docs/MacOsARM64/appplicationLogs-macosarm64-configureReceiver.md index 3513628a86..2b2d346f3a 100644 --- a/frontend/src/container/OnboardingContainer/Modules/LogsManagement/ApplicationLogs/md-docs/MacOsARM64/appplicationLogs-macosarm64-configureReceiver.md +++ b/frontend/src/container/OnboardingContainer/Modules/LogsManagement/ApplicationLogs/md-docs/MacOsARM64/appplicationLogs-macosarm64-configureReceiver.md @@ -7,11 +7,13 @@ receivers: ... filelog/app: include: [ /tmp/app.log ] - start_at: beginning + start_at: end ... ``` Replace `/tmp/app.log` with the path to your log file. +Note: change the `start_at` value to `beginning` if you want to read the log file from the beginning. It may be useful if you want to send old logs to SigNoz. The log records older than the standard log retention period (default 15 days) will be discarded. + For more configurations that are available for syslog receiver please check [here](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/filelogreceiver). ### Step 2: Include filelog receiver in the Pipeline