Skip to content
This repository was archived by the owner on Dec 14, 2022. It is now read-only.

Commit e8ef02c

Browse files
author
Chris Wiechmann
committed
Update README.md
1 parent 58acb21 commit e8ef02c

File tree

1 file changed

+15
-24
lines changed

1 file changed

+15
-24
lines changed

README.md

Lines changed: 15 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -97,20 +97,22 @@ After this configuration has been done, Open-Traffic log-files will be created b
9797

9898
#### Download and extract the release package
9999

100-
Please download the release package from the GitHub project onto your machine:
100+
Please download and extract the release package from the GitHub project onto your machine(s):
101101
```
102102
wget --no-check-certificate https://github.com/Axway-API-Management-Plus/apigateway-openlogging-elk/releases/download/v1.0.0-RC4/axway-apim-elk-v1.0.0-RC4.tar.gz -O - | tar -xvz
103103
```
104-
And rename the provided file `env-sample` to `.env`.
104+
To simplify updates it is recommended to create a Symlink-Folder and finally rename the provided file `env-sample` to `.env`.
105105
```
106+
ln -s axway-apim-elk-v1.0.0-RC4 axway-apim-elk
106107
cd axway-apim-elk-v1.0.0-RC4
107108
mv env-sample .env
108109
```
109110

110-
From this point on it is assumed that all commands are executed within the unpacked release. It is important that the `.env' can be found by Docker-Compose.
111-
If, as recommended, you run the solution on different machines, it is also assumed that you download and unpack the release package on each machine. And then provide the `.env` file.
111+
From this point on it is assumed that all commands are executed within the unpacked release folder. As it is important that the `.env' can be found by Docker-Compose.
112+
If, as recommended, you run the solution on different machines, it is also assumed that you download and unpack the release package on each machine. And then provide the `.env` file.
113+
Furthermore, it is recommended to store the .env as central configuration file in a version management system.
112114

113-
Even if otherwise possible, it is recommended to deploy the individual components in the following order For each component you can then check if it is functional.
115+
Even if otherwise possible, it is recommended to deploy the individual components in the following order. For each component you can then check if it is functional.
114116

115117
#### Elasticsearch
116118

@@ -535,9 +537,10 @@ With each release the following artifacts may change:
535537
All components of this solution play together and only work if they are from the same release. The solution will check if for example the index templates have the required version.
536538
With each update there will be a changelog, release notes and instructions for the update. For each component it will be explained whether there have been changes and how to apply them if necessary.
537539

538-
:exclamation: It is strongly discouraged to make changes in any files of the project, except the .env file. These will be overwritten with the next release. This is the only way to easily update from one version to the next.
540+
:exclamation: It is strongly discouraged to make changes in any files of the project, except the `.env` file. These will be overwritten with the next release. This is the only way to easily update from one version to the next.
539541
If you encounter a problem or need a feature, please open an issue that can be integrated directly into the solution.
540-
Of course you are welcome to create your own Kibana dashboards or clone and customize existing ones.
542+
Of course you are welcome to create your own Kibana dashboards or clone and customize existing ones.
543+
However, if you need to change files, it is recommended to make this change automatically and repeatable (e.g. https://www.ansible.com).
541544

542545
## Troubleshooting
543546

@@ -579,27 +582,15 @@ ls -l /var/log/work
579582
```
580583

581584
### Check Logstash processing
582-
Logstash write to Stdout, hence you can view information just with:
585+
Logstash writes to Stdout, hence you can view information just with:
583586
```
584-
docker logs apigateway-openlogging-elk_logstash_1_c6227859a9a4 --follow
587+
docker logs logstash -f
585588
```
586589
When Logstash is successfully started you should see the following:
587590
```
588-
[INFO ][logstash.javapipeline ] Starting pipeline {:pipeline_id=>"main", "pipeline.workers"=>1, "pipeline.batch.size"=>20, "pipeline.batch.delay"=>50, "pipeline.max_inflight"=>20, :thread=>"#<Thread:0x7d34e839 run>"}
589-
[INFO ][logstash.inputs.beats ] Beats inputs: Starting input listener {:address=>"0.0.0.0:5044"}
590-
[INFO ][logstash.javapipeline ] Pipeline started {"pipeline.id"=>"main"}
591-
[INFO ][org.logstash.beats.Server] Starting server on port: 5044
592-
[INFO ][logstash.agent ] Pipelines running {:count=>1, :running_pipelines=>[:main], :non_running_pipelines=>[]}
593-
...
594-
......
595-
...
596-
[INFO ][logstash.outputs.elasticsearch] Elasticsearch pool URLs updated {:changes=>{:removed=>[], :added=>[https://elasticsearch1:9200/]}}
597-
[INFO ][logstash.outputs.elasticsearch] ES Output version determined {:es_version=>7}
598-
[INFO ][logstash.outputs.elasticsearch] New Elasticsearch output {:class=>"LogStash::Outputs::ElasticSearch", :hosts=>["//elasticsearch1:9200"]}
599-
[INFO ][logstash.javapipeline ] Starting pipeline {:pipeline_id=>".monitoring-logstash", "pipeline.workers"=>1, "pipeline.batch.size"=>2, "pipeline.batch.delay"=>50, "pipeline.max_inflight"=>2, :thread=>"#<Thread:0x147f9919 run>"}
600-
[INFO ][logstash.javapipeline ] Pipeline started {"pipeline.id"=>".monitoring-logstash"}
601-
[INFO ][logstash.agent ] Pipelines running {:count=>2, :running_pipelines=>[:main, :".monitoring-logstash"], :non_running_pipelines=>[]}
602-
[INFO ][logstash.agent ] Successfully started Logstash API endpoint {:port=>9600}
591+
docker logs logstash
592+
Pipelines running {:count=>6, :running_pipelines=>[:".monitoring-logstash", :BeatsInput, :Events, :DomainAudit, :TraceMessages, :OpenTraffic], :non_running_pipelines=>[]}
593+
Successfully started Logstash API endpoint {:port=>9600}
603594
```
604595
If you see the following or similar error message during processing of events the API-Builder Lookup-API cannot be reached. In case, please make sure the environment variable: `API_BUILDER_URL`is set correctly.
605596
```

0 commit comments

Comments
 (0)