Skip to content

Commit 43600c7

Browse files
michaelwang13michaelwang13
authored
update help text for log drains (#376)
* update help text for log drains * sync readme * wording update * forgot to sync... * fix spacing * sync readme * ... 1 character too long
1 parent fcae5bc commit 43600c7

File tree

2 files changed

+30
-17
lines changed

2 files changed

+30
-17
lines changed

‎README.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -76,13 +76,13 @@ Commands:
7676
aptible environment:list # List all environments
7777
aptible environment:rename OLD_HANDLE NEW_HANDLE # Rename an environment handle. In order for the new environment handle to appear in log drain/metric destinations, you must restart the apps/databases in this environment.
7878
aptible help [COMMAND] # Describe available commands or one specific command
79-
aptible log_drain:create:datadog HANDLE --url DATADOG_URL --environment ENVIRONMENT [--drain-apps true/false] [--drain_databases true/false] [--drain_ephemeral_sessions true/false] [--drain_proxies true/false] # Create a Datadog Log Drain
80-
aptible log_drain:create:elasticsearch HANDLE --db DATABASE_HANDLE --environment ENVIRONMENT [--drain-apps true/false] [--drain_databases true/false] [--drain_ephemeral_sessions true/false] [--drain_proxies true/false] # Create an Elasticsearch Log Drain
81-
aptible log_drain:create:https HANDLE --url URL --environment ENVIRONMENT [--drain-apps true/false] [--drain_databases true/false] [--drain_ephemeral_sessions true/false] [--drain_proxies true/false] # Create a HTTPS Drain
82-
aptible log_drain:create:logdna HANDLE --url LOGDNA_URL --environment ENVIRONMENT [--drain-apps true/false] [--drain_databases true/false] [--drain_ephemeral_sessions true/false] [--drain_proxies true/false] # Create a LogDNA Log Drain
83-
aptible log_drain:create:papertrail HANDLE --host PAPERTRAIL_HOST --port PAPERTRAIL_PORT --environment ENVIRONMENT [--drain-apps true/false] [--drain_databases true/false] [--drain_ephemeral_sessions true/false] [--drain_proxies true/false] # Create a Papertrail Log Drain
84-
aptible log_drain:create:sumologic HANDLE --url SUMOLOGIC_URL --environment ENVIRONMENT [--drain-apps true/false] [--drain_databases true/false] [--drain_ephemeral_sessions true/false] [--drain_proxies true/false] # Create a Sumologic Drain
85-
aptible log_drain:create:syslog HANDLE --host SYSLOG_HOST --port SYSLOG_PORT [--token TOKEN] --environment ENVIRONMENT [--drain-apps true/false] [--drain_databases true/false] [--drain_ephemeral_sessions true/false] [--drain_proxies true/false] # Create a Papertrail Log Drain
79+
aptible log_drain:create:datadog HANDLE --url DATADOG_URL --environment ENVIRONMENT [--drain-apps|--no-drain-apps] [--drain-databases|--no-drain-databases] [--drain-ephemeral-sessions|--no-drain-ephemeral-sessions] [--drain_proxies|--no-drain-proxies] # Create a Datadog Log Drain. By default, App, Database, Ephemeral Session, and Proxy logs will be sent to your chosen destination.
80+
aptible log_drain:create:elasticsearch HANDLE --db DATABASE_HANDLE --environment ENVIRONMENT [--drain-apps|--no-drain-apps] [--drain-databases|--no-drain-databases] [--drain-ephemeral-sessions|--no-drain-ephemeral-sessions] [--drain_proxies|--no-drain-proxies] # Create an Elasticsearch Log Drain. By default, App, Database, Ephemeral Session, and Proxy logs will be sent to your chosen destination.
81+
aptible log_drain:create:https HANDLE --url URL --environment ENVIRONMENT [--drain-apps|--no-drain-apps] [--drain-databases|--no-drain-databases] [--drain-ephemeral-sessions|--no-drain-ephemeral-sessions] [--drain_proxies|--no-drain-proxies] # Create a HTTPS Drain
82+
aptible log_drain:create:logdna HANDLE --url LOGDNA_URL --environment ENVIRONMENT [--drain-apps|--no-drain-apps] [--drain-databases|--no-drain-databases] [--drain-ephemeral-sessions|--no-drain-ephemeral-sessions] [--drain_proxies|--no-drain-proxies] # Create a LogDNA/Mezmo Log Drain. By default, App, Database, Ephemeral Session, and Proxy logs will be sent to your chosen destination.
83+
aptible log_drain:create:papertrail HANDLE --host PAPERTRAIL_HOST --port PAPERTRAIL_PORT --environment ENVIRONMENT [--drain-apps|--no-drain-apps] [--drain-databases|--no-drain-databases] [--drain-ephemeral-sessions|--no-drain-ephemeral-sessions] [--drain_proxies|--no-drain-proxies] # Create a Papertrail Log Drain. By default, App, Database, Ephemeral Session, and Proxy logs will be sent to your chosen destination.
84+
aptible log_drain:create:sumologic HANDLE --url SUMOLOGIC_URL --environment ENVIRONMENT [--drain-apps|--no-drain-apps] [--drain-databases|--no-drain-databases] [--drain-ephemeral-sessions|--no-drain-ephemeral-sessions] [--drain_proxies|--no-drain-proxies] # Create a Sumologic Drain. By default, App, Database, Ephemeral Session, and Proxy logs will be sent to your chosen destination.
85+
aptible log_drain:create:syslog HANDLE --host SYSLOG_HOST --port SYSLOG_PORT [--token TOKEN] --environment ENVIRONMENT [--drain-apps|--no-drain-apps] [--drain-databases|--no-drain-databases] [--drain-ephemeral-sessions|--no-drain-ephemeral-sessions] [--drain_proxies|--no-drain-proxies] # Create a Syslog Log Drain. By default, App, Database, Ephemeral Session, and Proxy logs will be sent to your chosen destination.
8686
aptible log_drain:deprovision HANDLE --environment ENVIRONMENT # Deprovisions a log drain
8787
aptible log_drain:list # List all Log Drains
8888
aptible login # Log in to Aptible

‎lib/aptible/cli/subcommands/log_drain.rb‎

Lines changed: 23 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,11 @@ def self.included(thor)
1010
include Helpers::Telemetry
1111

1212
drain_flags = '--environment ENVIRONMENT ' \
13-
'[--drain-apps true/false] ' \
14-
'[--drain_databases true/false] ' \
15-
'[--drain_ephemeral_sessions true/false] ' \
16-
'[--drain_proxies true/false]'
13+
'[--drain-apps|--no-drain-apps] ' \
14+
'[--drain-databases|--no-drain-databases] ' \
15+
'[--drain-ephemeral-sessions|' \
16+
+'--no-drain-ephemeral-sessions] ' \
17+
'[--drain_proxies|--no-drain-proxies]'
1718

1819
def self.drain_options
1920
option :drain_apps, default: true, type: :boolean
@@ -54,7 +55,9 @@ def self.drain_options
5455
desc 'log_drain:create:elasticsearch HANDLE '\
5556
'--db DATABASE_HANDLE ' \
5657
+ drain_flags,
57-
'Create an Elasticsearch Log Drain'
58+
'Create an Elasticsearch Log Drain. By default, App, ' \
59+
+'Database, Ephemeral Session, and Proxy logs will be sent ' \
60+
+'to your chosen destination.'
5861
drain_options
5962
option :db, type: :string
6063
option :pipeline, type: :string
@@ -81,7 +84,9 @@ def self.drain_options
8184
desc 'log_drain:create:datadog HANDLE ' \
8285
'--url DATADOG_URL ' \
8386
+ drain_flags,
84-
'Create a Datadog Log Drain'
87+
'Create a Datadog Log Drain. By default, App, Database, ' \
88+
+ 'Ephemeral Session, and Proxy logs will be sent ' \
89+
+ 'to your chosen destination.'
8590
drain_options
8691
option :url, type: :string
8792
define_method 'log_drain:create:datadog' do |handle|
@@ -107,7 +112,9 @@ def self.drain_options
107112
desc 'log_drain:create:sumologic HANDLE ' \
108113
'--url SUMOLOGIC_URL ' \
109114
+ drain_flags,
110-
'Create a Sumologic Drain'
115+
'Create a Sumologic Drain. By default, App, Database, ' \
116+
+ 'Ephemeral Session, and Proxy logs will be sent ' \
117+
+ 'to your chosen destination.'
111118
option :url, type: :string
112119
drain_options
113120
define_method 'log_drain:create:sumologic' do |handle|
@@ -118,7 +125,9 @@ def self.drain_options
118125
desc 'log_drain:create:logdna HANDLE ' \
119126
'--url LOGDNA_URL ' \
120127
+ drain_flags,
121-
'Create a LogDNA Log Drain'
128+
'Create a LogDNA/Mezmo Log Drain. By default, App, ' \
129+
+ 'Database, Ephemeral Session, and Proxy logs ' \
130+
+ 'will be sent to your chosen destination.'
122131
option :url, type: :string
123132
drain_options
124133
define_method 'log_drain:create:logdna' do |handle|
@@ -132,7 +141,9 @@ def self.drain_options
132141
desc 'log_drain:create:papertrail HANDLE ' \
133142
'--host PAPERTRAIL_HOST --port PAPERTRAIL_PORT ' \
134143
+ drain_flags,
135-
'Create a Papertrail Log Drain'
144+
'Create a Papertrail Log Drain. By default, App, Database, ' \
145+
+ 'Ephemeral Session, and Proxy logs will be sent ' \
146+
+ 'to your chosen destination.'
136147
option :host, type: :string
137148
option :port, type: :string
138149
drain_options
@@ -145,7 +156,9 @@ def self.drain_options
145156
'--host SYSLOG_HOST --port SYSLOG_PORT ' \
146157
'[--token TOKEN] ' \
147158
+ drain_flags,
148-
'Create a Papertrail Log Drain'
159+
'Create a Syslog Log Drain. By default, App, Database, ' \
160+
+ 'Ephemeral Session, and Proxy logs will be sent ' \
161+
+ 'to your chosen destination.'
149162
option :host, type: :string
150163
option :port, type: :string
151164
option :token, type: :string

0 commit comments

Comments
 (0)