From f8a131795f8645cd80fa4c9f265219cec57bd6fe Mon Sep 17 00:00:00 2001 From: eason lau Date: Thu, 8 Feb 2018 22:27:15 -0500 Subject: [PATCH 1/4] add README.md --- templates/filebeat/0/README.md | 8 ++++++++ templates/filebeat/0/rancher-compose.yml | 4 ++-- templates/filebeat/1/README.md | 8 ++++++++ templates/filebeat/1/rancher-compose.yml | 4 ++-- templates/filebeat/2/README.md | 8 ++++++++ templates/filebeat/2/rancher-compose.yml | 4 ++-- templates/filebeat/README.md | 8 ++++++++ 7 files changed, 38 insertions(+), 6 deletions(-) create mode 100644 templates/filebeat/0/README.md create mode 100644 templates/filebeat/1/README.md create mode 100644 templates/filebeat/2/README.md create mode 100644 templates/filebeat/README.md diff --git a/templates/filebeat/0/README.md b/templates/filebeat/0/README.md new file mode 100644 index 0000000..64542dd --- /dev/null +++ b/templates/filebeat/0/README.md @@ -0,0 +1,8 @@ +### Log Shipper to logstash +* Support ship APP log and Nginx log or one of both to Logstash +* Let it default if you only have one log type of both APP log and Ningx log. +* Also you can put all any type log(include app/nginx/other type) to Application Log Path with below pattern. +eg: +${HOME_PATH}/app/logs/xxx.log +${HOME_PATH}/nginx/logs/xxx.log +${HOME_PATH}/others/logs/xxx.log diff --git a/templates/filebeat/0/rancher-compose.yml b/templates/filebeat/0/rancher-compose.yml index 5177491..d6b3dd0 100644 --- a/templates/filebeat/0/rancher-compose.yml +++ b/templates/filebeat/0/rancher-compose.yml @@ -25,13 +25,13 @@ catalog: type: "string" - variable: "APPLOG_PATH" label: "Application Log Path" - description: "For alignment, put your log into below path: ${HOME_PATH}/App1/logs/xxx.log, assume your HOME_PATH=/home/user, then set Application log Path as /home/user/." + description: "For alignment, put your log into below path: ${HOME_PATH}/App1/logs/xxx.log, assume your HOME_PATH=/home/user, then set Application log Path as /home/user/, let it default if there is no app log." required: true default: "/home/user/" type: "string" - variable: "NGINXLOG_PATH" label: "Nginx Log Path" - description: "Default it as /var/log/nginx/" + description: "Default it as /var/log/nginx/, let it default if there is no nginx log." default: "/var/log/nginx/" type: "string" required: true diff --git a/templates/filebeat/1/README.md b/templates/filebeat/1/README.md new file mode 100644 index 0000000..64542dd --- /dev/null +++ b/templates/filebeat/1/README.md @@ -0,0 +1,8 @@ +### Log Shipper to logstash +* Support ship APP log and Nginx log or one of both to Logstash +* Let it default if you only have one log type of both APP log and Ningx log. +* Also you can put all any type log(include app/nginx/other type) to Application Log Path with below pattern. +eg: +${HOME_PATH}/app/logs/xxx.log +${HOME_PATH}/nginx/logs/xxx.log +${HOME_PATH}/others/logs/xxx.log diff --git a/templates/filebeat/1/rancher-compose.yml b/templates/filebeat/1/rancher-compose.yml index 0ea389f..1d4b7f0 100644 --- a/templates/filebeat/1/rancher-compose.yml +++ b/templates/filebeat/1/rancher-compose.yml @@ -25,13 +25,13 @@ catalog: type: "string" - variable: "APPLOG_PATH" label: "Application Log Path" - description: "For alignment, put your log into below path: ${HOME_PATH}/App1/logs/xxx.log, assume your HOME_PATH=/home/user, then set Application log Path as /home/user/." + description: "For alignment, put your log into below path: ${HOME_PATH}/App1/logs/xxx.log, assume your HOME_PATH=/home/user, then set Application log Path as /home/user/, let it default if there is no app log." required: true default: "/home/user/" type: "string" - variable: "NGINXLOG_PATH" label: "Nginx Log Path" - description: "Default it as /var/log/nginx/" + description: "Default it as /var/log/nginx/, let it default if there is no nginx log." default: "/var/log/nginx/" type: "string" required: true diff --git a/templates/filebeat/2/README.md b/templates/filebeat/2/README.md new file mode 100644 index 0000000..64542dd --- /dev/null +++ b/templates/filebeat/2/README.md @@ -0,0 +1,8 @@ +### Log Shipper to logstash +* Support ship APP log and Nginx log or one of both to Logstash +* Let it default if you only have one log type of both APP log and Ningx log. +* Also you can put all any type log(include app/nginx/other type) to Application Log Path with below pattern. +eg: +${HOME_PATH}/app/logs/xxx.log +${HOME_PATH}/nginx/logs/xxx.log +${HOME_PATH}/others/logs/xxx.log diff --git a/templates/filebeat/2/rancher-compose.yml b/templates/filebeat/2/rancher-compose.yml index 7b543e7..47aabf4 100644 --- a/templates/filebeat/2/rancher-compose.yml +++ b/templates/filebeat/2/rancher-compose.yml @@ -25,13 +25,13 @@ catalog: type: "string" - variable: "APPLOG_PATH" label: "Application Log Path" - description: "For alignment, put your log into below path: ${HOME_PATH}/App1/logs/xxx.log, assume your HOME_PATH=/home/user, then set Application log Path as /home/user/." + description: "For alignment, put your log into below path: ${HOME_PATH}/App1/logs/xxx.log, assume your HOME_PATH=/home/user, then set Application log Path as /home/user/, let it default if there is no app log." required: true default: "/home/user/" type: "string" - variable: "NGINXLOG_PATH" label: "Nginx Log Path" - description: "Default it as /var/log/nginx/" + description: "Default it as /var/log/nginx/, let it default if there is no nginx log." default: "/var/log/nginx/" type: "string" required: true diff --git a/templates/filebeat/README.md b/templates/filebeat/README.md new file mode 100644 index 0000000..64542dd --- /dev/null +++ b/templates/filebeat/README.md @@ -0,0 +1,8 @@ +### Log Shipper to logstash +* Support ship APP log and Nginx log or one of both to Logstash +* Let it default if you only have one log type of both APP log and Ningx log. +* Also you can put all any type log(include app/nginx/other type) to Application Log Path with below pattern. +eg: +${HOME_PATH}/app/logs/xxx.log +${HOME_PATH}/nginx/logs/xxx.log +${HOME_PATH}/others/logs/xxx.log From 11e44b6113def29d58049cebd5893e508c27b6a0 Mon Sep 17 00:00:00 2001 From: eason lau Date: Thu, 8 Feb 2018 22:29:49 -0500 Subject: [PATCH 2/4] update README.md --- templates/filebeat/0/README.md | 2 ++ templates/filebeat/1/README.md | 2 ++ templates/filebeat/2/README.md | 2 ++ templates/filebeat/README.md | 2 ++ 4 files changed, 8 insertions(+) diff --git a/templates/filebeat/0/README.md b/templates/filebeat/0/README.md index 64542dd..61b4174 100644 --- a/templates/filebeat/0/README.md +++ b/templates/filebeat/0/README.md @@ -2,7 +2,9 @@ * Support ship APP log and Nginx log or one of both to Logstash * Let it default if you only have one log type of both APP log and Ningx log. * Also you can put all any type log(include app/nginx/other type) to Application Log Path with below pattern. +```bash eg: ${HOME_PATH}/app/logs/xxx.log ${HOME_PATH}/nginx/logs/xxx.log ${HOME_PATH}/others/logs/xxx.log +``` diff --git a/templates/filebeat/1/README.md b/templates/filebeat/1/README.md index 64542dd..61b4174 100644 --- a/templates/filebeat/1/README.md +++ b/templates/filebeat/1/README.md @@ -2,7 +2,9 @@ * Support ship APP log and Nginx log or one of both to Logstash * Let it default if you only have one log type of both APP log and Ningx log. * Also you can put all any type log(include app/nginx/other type) to Application Log Path with below pattern. +```bash eg: ${HOME_PATH}/app/logs/xxx.log ${HOME_PATH}/nginx/logs/xxx.log ${HOME_PATH}/others/logs/xxx.log +``` diff --git a/templates/filebeat/2/README.md b/templates/filebeat/2/README.md index 64542dd..61b4174 100644 --- a/templates/filebeat/2/README.md +++ b/templates/filebeat/2/README.md @@ -2,7 +2,9 @@ * Support ship APP log and Nginx log or one of both to Logstash * Let it default if you only have one log type of both APP log and Ningx log. * Also you can put all any type log(include app/nginx/other type) to Application Log Path with below pattern. +```bash eg: ${HOME_PATH}/app/logs/xxx.log ${HOME_PATH}/nginx/logs/xxx.log ${HOME_PATH}/others/logs/xxx.log +``` diff --git a/templates/filebeat/README.md b/templates/filebeat/README.md index 64542dd..61b4174 100644 --- a/templates/filebeat/README.md +++ b/templates/filebeat/README.md @@ -2,7 +2,9 @@ * Support ship APP log and Nginx log or one of both to Logstash * Let it default if you only have one log type of both APP log and Ningx log. * Also you can put all any type log(include app/nginx/other type) to Application Log Path with below pattern. +```bash eg: ${HOME_PATH}/app/logs/xxx.log ${HOME_PATH}/nginx/logs/xxx.log ${HOME_PATH}/others/logs/xxx.log +``` From d43a41ed7c98da7f2bdbe0902cdab7e77ef75244 Mon Sep 17 00:00:00 2001 From: eason lau Date: Thu, 8 Feb 2018 22:31:39 -0500 Subject: [PATCH 3/4] update README.md --- templates/filebeat/0/README.md | 1 + templates/filebeat/1/README.md | 1 + templates/filebeat/2/README.md | 1 + templates/filebeat/README.md | 1 + 4 files changed, 4 insertions(+) diff --git a/templates/filebeat/0/README.md b/templates/filebeat/0/README.md index 61b4174..f2b0b99 100644 --- a/templates/filebeat/0/README.md +++ b/templates/filebeat/0/README.md @@ -8,3 +8,4 @@ ${HOME_PATH}/app/logs/xxx.log ${HOME_PATH}/nginx/logs/xxx.log ${HOME_PATH}/others/logs/xxx.log ``` +And set Application Log Path as your `${HOME_PATH}` diff --git a/templates/filebeat/1/README.md b/templates/filebeat/1/README.md index 61b4174..f2b0b99 100644 --- a/templates/filebeat/1/README.md +++ b/templates/filebeat/1/README.md @@ -8,3 +8,4 @@ ${HOME_PATH}/app/logs/xxx.log ${HOME_PATH}/nginx/logs/xxx.log ${HOME_PATH}/others/logs/xxx.log ``` +And set Application Log Path as your `${HOME_PATH}` diff --git a/templates/filebeat/2/README.md b/templates/filebeat/2/README.md index 61b4174..f2b0b99 100644 --- a/templates/filebeat/2/README.md +++ b/templates/filebeat/2/README.md @@ -8,3 +8,4 @@ ${HOME_PATH}/app/logs/xxx.log ${HOME_PATH}/nginx/logs/xxx.log ${HOME_PATH}/others/logs/xxx.log ``` +And set Application Log Path as your `${HOME_PATH}` diff --git a/templates/filebeat/README.md b/templates/filebeat/README.md index 61b4174..f2b0b99 100644 --- a/templates/filebeat/README.md +++ b/templates/filebeat/README.md @@ -8,3 +8,4 @@ ${HOME_PATH}/app/logs/xxx.log ${HOME_PATH}/nginx/logs/xxx.log ${HOME_PATH}/others/logs/xxx.log ``` +And set Application Log Path as your `${HOME_PATH}` From 004ace0ff09f1c982f7935af08d196f4deb7742f Mon Sep 17 00:00:00 2001 From: eason lau Date: Fri, 9 Feb 2018 04:27:36 -0500 Subject: [PATCH 4/4] update --- templates/filebeat/0/README.md | 1 + templates/filebeat/1/README.md | 1 + templates/filebeat/2/README.md | 1 + templates/filebeat/README.md | 1 + 4 files changed, 4 insertions(+) diff --git a/templates/filebeat/0/README.md b/templates/filebeat/0/README.md index f2b0b99..1fd5113 100644 --- a/templates/filebeat/0/README.md +++ b/templates/filebeat/0/README.md @@ -1,4 +1,5 @@ ### Log Shipper to logstash +* Before choose your filebeat version to launch, please make sure Beats [Support Matrix](https://www.elastic.co/support/matrix#matrix_compatibility) * Support ship APP log and Nginx log or one of both to Logstash * Let it default if you only have one log type of both APP log and Ningx log. * Also you can put all any type log(include app/nginx/other type) to Application Log Path with below pattern. diff --git a/templates/filebeat/1/README.md b/templates/filebeat/1/README.md index f2b0b99..1fd5113 100644 --- a/templates/filebeat/1/README.md +++ b/templates/filebeat/1/README.md @@ -1,4 +1,5 @@ ### Log Shipper to logstash +* Before choose your filebeat version to launch, please make sure Beats [Support Matrix](https://www.elastic.co/support/matrix#matrix_compatibility) * Support ship APP log and Nginx log or one of both to Logstash * Let it default if you only have one log type of both APP log and Ningx log. * Also you can put all any type log(include app/nginx/other type) to Application Log Path with below pattern. diff --git a/templates/filebeat/2/README.md b/templates/filebeat/2/README.md index f2b0b99..1fd5113 100644 --- a/templates/filebeat/2/README.md +++ b/templates/filebeat/2/README.md @@ -1,4 +1,5 @@ ### Log Shipper to logstash +* Before choose your filebeat version to launch, please make sure Beats [Support Matrix](https://www.elastic.co/support/matrix#matrix_compatibility) * Support ship APP log and Nginx log or one of both to Logstash * Let it default if you only have one log type of both APP log and Ningx log. * Also you can put all any type log(include app/nginx/other type) to Application Log Path with below pattern. diff --git a/templates/filebeat/README.md b/templates/filebeat/README.md index f2b0b99..1fd5113 100644 --- a/templates/filebeat/README.md +++ b/templates/filebeat/README.md @@ -1,4 +1,5 @@ ### Log Shipper to logstash +* Before choose your filebeat version to launch, please make sure Beats [Support Matrix](https://www.elastic.co/support/matrix#matrix_compatibility) * Support ship APP log and Nginx log or one of both to Logstash * Let it default if you only have one log type of both APP log and Ningx log. * Also you can put all any type log(include app/nginx/other type) to Application Log Path with below pattern.