You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Dec 14, 2022. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+15-24Lines changed: 15 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -97,20 +97,22 @@ After this configuration has been done, Open-Traffic log-files will be created b
97
97
98
98
#### Download and extract the release package
99
99
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):
101
101
```
102
102
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
103
103
```
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`.
105
105
```
106
+
ln -s axway-apim-elk-v1.0.0-RC4 axway-apim-elk
106
107
cd axway-apim-elk-v1.0.0-RC4
107
108
mv env-sample .env
108
109
```
109
110
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.
112
114
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.
114
116
115
117
#### Elasticsearch
116
118
@@ -535,9 +537,10 @@ With each release the following artifacts may change:
535
537
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.
536
538
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.
537
539
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.
539
541
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).
541
544
542
545
## Troubleshooting
543
546
@@ -579,27 +582,15 @@ ls -l /var/log/work
579
582
```
580
583
581
584
### 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:
Successfully started Logstash API endpoint {:port=>9600}
603
594
```
604
595
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.
0 commit comments