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

Commit adaa346

Browse files
author
Chris Wiechmann
committed
[skip ci] Readme improved
1 parent 9b7a408 commit adaa346

File tree

4 files changed

+9
-5
lines changed

4 files changed

+9
-5
lines changed

.github/workflows/logstash.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ on: [push, pull_request]
44

55
jobs:
66
test-logstash:
7+
if: "!contains(github.event.head_commit.message, 'skip ci')"
78
runs-on: ubuntu-latest
89

910
steps:

.github/workflows/traffic-monitor-api.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ on:
1515

1616
jobs:
1717
build:
18+
if: "!contains(github.event.head_commit.message, 'skip ci')"
1819
env:
1920
workingDirectory: 'elk-traffic-monitor-api'
2021

@@ -48,7 +49,7 @@ jobs:
4849
npm ci
4950
npm run build --if-present
5051
npm test
51-
- name: Publish Docker image
52+
- name: Publish Docker image (latest)
5253
uses: elgohr/Publish-Docker-Github-Action@2.13
5354
with:
5455
name: cwiechmann/elk-traffic-monitor-api

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,10 @@ The compare attribute filter should look like this:
7373
![Connect to ES API][img7]
7474
- Insert the created policy as a callback policy (filter: Shortcut filter) into the main policy: `Protect Management Interfaces` and wire it like shown here:
7575
![Use Callback][img4]
76+
77+
:point_right: It is recommended to disable the audit log for Failure transaction to avoid unneeded log messages in the ANM trace file:
78+
![Use Callback][img4]
79+
You may add a custom Success-Message (e.g. `Used ElasticSearch API`) is you like.
7680

7781
After you have saved, copy the configuration files from your local *Policy Studio* project (path on Linux: `/home/<user>/apiprojects/\<project-name\>`) back the configuration to the Admin-Node-Manager configuration (`\<install-dir\>/apigateway/conf/fed`) and restarted it. The Admin-Node-Manager will use the API provided by API-Builder to query the Elasticsearch API to serve the specified request-types.
7882

@@ -211,10 +215,6 @@ It is important to know that traffic information will still appear in this case,
211215
```
212216
tail -f /opt/Axway/APIM/apigateway/trace/nodemanageronapi-env_20200813000000.trc
213217
```
214-
In case you see the following message logged, please check the API-Builder process is running and reachable from the ANM.
215-
```
216-
logged Failure at 08.13.2020 05:46:09,730 with log description: Failed in calling policy shortcut
217-
```
218218

219219
#### Check queries send to ElasticSearch
220220
In oder to see queries that are send to ElasticSearch by API-Builder you need to run the Docker-Container with `LOG_LEVEL=debug`. You can activate debug in the docker-compose.yml. This gives you in the console of the API-Builder the following output:
@@ -233,5 +233,7 @@ This helps you to further analyze if ElasticSearch is returning the correct info
233233
[img6]: imgs/IsmanagedbyElasticsearchAPI.png
234234
[img7]: imgs/connect-to-elasticsearch-api.png
235235
[img8]: imgs/kibana-dev-tool-sample-query.png
236+
[img9]: imgs/policy-shortcut-disable-failure.png
237+
236238

237239
[1]: https://docs.axway.com/bundle/axway-open-docs/page/docs/apim_administration/apigtw_admin/admin_open_logging/index.html#configure-open-traffic-event-logging
8.4 KB
Loading

0 commit comments

Comments
 (0)