Skip to content

Commit

Permalink
Doc Fix (#324)
Browse files Browse the repository at this point in the history
* Doc Fix

Removes previously deprecated skipLogs setting from readme.

* Typo in script example.
  • Loading branch information
nemonster authored Nov 11, 2019
1 parent daec1d6 commit d5eab76
Showing 1 changed file with 8 additions and 9 deletions.
17 changes: 8 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,6 @@ As a first step the diagnostic will check the Github repo for the current releas

## Additional Options
* You can specify additional java options such as a higher `-Xmx` value by setting the environment variable `DIAG_JAVA_OPTS`.
* To suppress all log file collection use the `--skipLogs` option.
* Because of the potential size access logs are no longer collected by default. If you need these use the `--accessLogs` option to have them copied.

## Alternate Usages
Expand Down Expand Up @@ -209,23 +208,23 @@ The additional parameters:

##### Simple case using defaults - data from the last 6 hours will be collected:
```$xslt
sudo ./export-momitoring.sh --host 10.0.0.20 -u elastic -p --ssl --id 37G473XV7843
sudo ./export-monitoring.sh --host 10.0.0.20 -u elastic -p --ssl --id 37G473XV7843
```
##### Specifies a specific date, time and uses default interval 6 hours:
```$xslt
sudo ./export-momitoring.sh --host 10.0.0.20 -u elastic -p --ssl --id 37G473XV7843 --start '2019-08-25 08:30'
sudo ./export-monitoring.sh --host 10.0.0.20 -u elastic -p --ssl --id 37G473XV7843 --start '2019-08-25 08:30'
```
##### Specifies the last 8 hours of data.
```$xslt
sudo ./export-momitoring.sh --host 10.0.0.20 -u elastic -p --ssl --id 37G473XV7843 --interval 8
sudo ./export-monitoring.sh --host 10.0.0.20 -u elastic -p --ssl --id 37G473XV7843 --interval 8
```
##### Specifies a specific date, time and interval:
```$xslt
sudo ./export-momitoring.sh --host 10.0.0.20 -u elastic -p --ssl --id 37G473XV7843 --start '2019-08-25 17:45' --interval 10
sudo ./export-monitoring.sh --host 10.0.0.20 -u elastic -p --ssl --id 37G473XV7843 --start '2019-08-25 17:45' --interval 10
```
##### Lists the clusters availble in this monitoring cluster
```$xslt
sudo ./export-momitoring.sh --host 10.0.0.20 -u elastic -p --ssl --list
sudo ./export-monitoring.sh --host 10.0.0.20 -u elastic -p --ssl --list
```

# Experimental - Monitoring Data Import
Expand All @@ -250,15 +249,15 @@ range to reflect the period that was collected so that it displays and is in a u

##### Uses the default cluster_id, index_name:
```$xslt
sudo ./import-momitoring.sh --host 10.0.0.20 -u elastic -p --ssl -i /Users/joe_user/temp/export-20190801-150615.zip
sudo ./import-monitoring.sh --host 10.0.0.20 -u elastic -p --ssl -i /Users/joe_user/temp/export-20190801-150615.zip
```
##### Uses the generated index name but gives the cluster a different name:
```$xslt
sudo ./import-momitoring.sh --host 10.0.0.20 -u elastic -p --ssl -i /Users/joe_user/temp/export-20190801-150615.zip -clusterName messed_up_cluster
sudo ./import-monitoring.sh --host 10.0.0.20 -u elastic -p --ssl -i /Users/joe_user/temp/export-20190801-150615.zip -clusterName messed_up_cluster
```
##### Uses a custom index and cluster name:
```$xslt
sudo ./import-momitoring.sh --host 10.0.0.20 -u elastic -p --ssl -i /Users/joe_user/temp/export-20190801-150615.zip -clusterName big_cluster --indexName big_cluster_2019_10_01
sudo ./import-monitoring.sh --host 10.0.0.20 -u elastic -p --ssl -i /Users/joe_user/temp/export-20190801-150615.zip -clusterName big_cluster --indexName big_cluster_2019_10_01
```
# Standard Diagnostic Troubleshooting
* The file: diagnostic.log file will be generated and included in the archive. In all but the worst case an archive will be created. Some messages will be written to the console output but granualar errors and stack traces will only be written to this log.
Expand Down

0 comments on commit d5eab76

Please sign in to comment.