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

Commit 1b19e87

Browse files
author
Chris Wiechmann
authored
Update README.md
1 parent 1e8dbf3 commit 1b19e87

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1133,6 +1133,7 @@ However, if you need to change files, it is recommended to make this change auto
11331133

11341134
## Troubleshooting
11351135

1136+
- [Solution does not show data in real time](#solution-does-not-show-data-in-real-time)
11361137
- [Check processes/containers are running](#check-processescontainers-are-running)
11371138
- [Check Filebeat is picking up data](#check-filebeat-is-picking-up-data)
11381139
- [Check Logstash processing](#check-logstash-processing)
@@ -1149,6 +1150,16 @@ However, if you need to change files, it is recommended to make this change auto
11491150
- [Kibana - Missing Long-Term-Statistics](#kibana---missing-long-term-statistics)
11501151
- [Too many API-Manager lookups](#too-many-api-manager-lookups)
11511152

1153+
### Solution does not show data in real time
1154+
1155+
An important aspect of the solution is to store the API requests as fast as possible in Elasticsearch, so that they are available in real-time in the API gateway traffic monitor or in the Kibana dashboard.
1156+
If your setup cannot process the log information fast enough, then the solution may never be real-time and eventually even log information may be lost.
1157+
The following video provides information on why the document ingest rate may be too low, what information is available for analysis in Kibana, and how to correct this if necessary.
1158+
1159+
[Axway API-Management Elasticsearch Integration - Performance Troubleshooting](https://youtu.be/rLT84dkgGAE)
1160+
1161+
<p align="right"><a href="#troubleshooting">Top</a></p>
1162+
11521163
### Check processes/containers are running
11531164
From within the folder where the docker-compose.yml file is located (git project folder) execute:
11541165
```
@@ -1385,8 +1396,9 @@ The main cause of this problem is the way the `http.status` field is indexed, wh
13851396
### Too many API-Manager lookups
13861397

13871398
API- and Application-Details are looked up as part of the Logstash pipeline from the API Manager using a APIBuilder4Elastic REST API. The obtained details are cached by Logstash using Memcache.
1388-
Now, if lookups are constantly performed nevertheless, then this might be caused by APIs directly exposed by the API-Gateways via policies, which have a path parameter (e.g /api/v1/cusomer/323213).
1389-
Because the path parameter makes the API path dynamic it prevents Logstash from caching it. In this case, you need to help the solution by setting an API name in the appropriate policies using the [Set Service Context](https://docs.axway.com/bundle/axway-open-docs/page/docs/apim_policydev/apigw_polref/monitoring_logging/index.html#set-service-context-filter) filter. For more information please see issue #180.
1399+
Now, if lookups are constantly performed nevertheless, then this might be caused by APIs which have a path parameter (e.g /api/v1/cusomer/323213).
1400+
Because the path parameter makes the API path dynamic it prevents Logstash from caching it. In this case, you need to help the solution by setting up the parameter: `CACHE_API_PATHS`.
1401+
You may also watch the following video to learn more about this topic: https://youtu.be/rLT84dkgGAE
13901402

13911403
<p align="right"><a href="#troubleshooting">Top</a></p>
13921404

0 commit comments

Comments
 (0)