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

Commit 44a5a46

Browse files
author
Chris Wiechmann
committed
Update README.md
1 parent 106eef0 commit 44a5a46

File tree

1 file changed

+2
-23
lines changed

1 file changed

+2
-23
lines changed

README.md

Lines changed: 2 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ Each API-Gateway instance is writing, [if configured](#enable-open-traffic-event
1313

1414
Once the data is indexed by Elasticsearch it can be used by different clients. This process allows almost realtime monitoring of incoming requests. It takes around 5 seconds until a request is available in Elasticsearch.
1515

16-
## Option 1 - Using the existing Traffic-Monitor
17-
One option is to use the existing API-Gateway Traffic-Monitor. That means, you use the same tooling as of today, but the underlying implementation of the Traffic-Monitor API is now pointing to Elasticsearch instead of the internal OPSDB hosted by each API-Gateway instance. This improves performance damatically, as Elasticsearch can scale across multiple machines if required and other dashboards can be created for instance with Kibana.
16+
## Using the existing Traffic-Monitor
17+
Use the existing API-Gateway Traffic-Monitor. That means, you use the same tooling as of today, but the underlying implementation of the Traffic-Monitor API is now pointing to Elasticsearch instead of the internal OPSDB hosted by each API-Gateway instance. This improves performance damatically, as Elasticsearch can scale across multiple machines if required and other dashboards can be created for instance with Kibana.
1818
The glue between Elasticsearch and the API-Gateway Traffic-Monitor is an [API-Builder project](./elk-traffic-monitor-api), that is exposing the same Traffic-Monitor API, but it is implemented using Elasticsearch instead of the OPSDB. The API-Builder is available as a ready to use Docker-Image and preconfigured in the docker-compose file.
1919
Optionally you can import the API-Builder API into your API-Management system to apply additional security and by that secure access to your Elasticsearch instance.
2020

@@ -23,27 +23,6 @@ Finally, the Admin-Node-Manager has to be [configured](#configure-the-admin-node
2323
API-Builder exposing Traffic-Monitor API:
2424
[![Traffic-Monitor API](https://github.com/Axway-API-Management-Plus/apigateway-openlogging-elk/workflows/Traffic-Monitor%20API/badge.svg)](https://github.com/Axway-API-Management-Plus/apigateway-openlogging-elk/actions)
2525

26-
## Option 2 - Loginspector
27-
The Loginspector is a new separated user-interface with very basic set of functionalities. As part of the project the Loginspector is activated by default when using `docker-compose up -d`. If you don't wanna use it, it can be disabled by commenting out the following lines in the docker-compose.yml file:
28-
```yaml
29-
nginx:
30-
image: nginx:1.17.6
31-
ports:
32-
- 8888:90
33-
volumes:
34-
- ${PWD}/nginx/www:/usr/share/nginx/html
35-
- ${PWD}/nginx/conf:/etc/nginx
36-
depends_on:
37-
- elasticsearch1
38-
networks:
39-
- elastic
40-
- ingress
41-
```
42-
The Log-Inspector is accessible on the following URL: `http://hostname-to-your-docker-machine:8888/logspector.html`
43-
44-
![Log-Inspector][img5]
45-
46-
4726
## Prerequisites
4827
For a simple deployment the prerequisites are very simple as all services can be started as a Docker-Container. In order to start all components in PoC-Like-Mode you just need:
4928

0 commit comments

Comments
 (0)