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

Commit fd0297d

Browse files
author
Chris Wiechmann
authored
[skip ci] A few more details about the local lookup
1 parent 6ce9681 commit fd0297d

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -494,15 +494,15 @@ This way the Admin-Node-Manager will only select data from these regional indexe
494494

495495
Starting with version 2.0.0 of the solution, it is optionally possible to use local configuration files for the API lookup in addition to the API Manager. This makes it possible to:
496496
1. Enrich native APIs
497-
- APIs that have been exposed natively through the API-Gateway policies
498-
- you can configure all information that would normally come from the API manager via the lookup file
497+
- APIs that have been exposed natively through the API-Gateway policies not having a context
498+
- you can configure all information that would normally be retrieved from the API-Manager via this lookup file
499499
- Organization, API-Name, API-Method-Name, Custom-Properties, ...
500500
- for example display a `/healthcheck` as `Healthcheck API` in Kibana dashboards
501501
2. Ignore events
502-
- You can ignore OpenTraffc events so that they are not indexed or stored in Elasticsearch.
502+
- Additionall you can ignore OpenTraffc events so that they are not indexed or stored in Elasticsearch.
503503
- For example, the path: `/favicon.ico`, as this event does not add value.
504504

505-
Please note that the local configuration file is used before the API manager lookup. If there is a match, no lookup to the API Manager is performed.
505+
Please note that the local configuration file is used before the API-Manager lookup. If there is a match, no lookup to the API-Manager is performed.
506506

507507
To enable the local lookup, you must perform the following steps:
508508

@@ -536,7 +536,7 @@ Error reading API-Lookup file: './config/api-lookup.json'
536536
#### Ignore APIs/Events
537537

538538
At this point, we intentionally refer to events and not APIs, because different events (TransactionSummy, CircuitPath, TransactionElement) are created in the OpenTraffic log for each API call. Each is processed separately by Logstash and stored using an upsert in Elasticsearch with the same Correlation-ID. Most of these events contain the path of the called API, but unfortunately not all.
539-
This is especially important when ignoring events so that they are not stored in Elasticsearch. Since all events are processed individually, it must also be decided individually to ignore an event.
539+
This is especially important when ignoring events so that they are not stored in Elasticsearch entirely. Since all events are processed individually, it must also be decided individually to ignore an event.
540540
Therefore, to ignore for example the Healthcheck API entirely, the following must be configured in the lookup file:
541541
```json
542542
{
@@ -551,7 +551,7 @@ Therefore, to ignore for example the Healthcheck API entirely, the following mus
551551
}
552552
```
553553
This will ignore events based on the path (TransactionSummary & TransactionElement) and the policy name (CircuitPath).
554-
You can see the result in the API builder log with the following lines:
554+
You can see the result in the API-Builder log on level INFO with the following lines:
555555
`Return API with apiPath: '/healthcheck', policyName: '' as to be ignored: true`
556556
or:
557557
`Return API with apiPath: '', policyName: 'Health Check' as to be ignored: true`

0 commit comments

Comments
 (0)