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

Commit fd2a08b

Browse files
author
Chris Wiechmann
authored
Merge pull request #15 from mpentzek/master
Added trace endpoint to Traffic Monitor API
2 parents 16e4702 + 38eb770 commit fd2a08b

12 files changed

+9890
-236
lines changed

‎README.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,10 +76,11 @@ For the following steps, please open the ANM configuration in Policy-Studio. You
7676

7777
- The `Compare Attribute` filter checks if the requested API can be handled by the API-Builder project.
7878
As a basis for decision-making a criteria for each endpoint needs to be added to the filter configuration.
79-
_At this point in time only two endpoints are supported by the API Builder based Traffic-Monitor API.
80-
The **search** endpoint which provides the data for the HTTP Traffic overview and the **circuitpath** endpoint which provides the data for the Filter Execution Path as part of the detailed view of a transaction. Currently the API Builder Project does not cover all endpoints to completely replace the existing Traffic Monitor API yet, but more endpoints will be added soon!_
79+
_At this point in time three endpoints are supported by the API Builder based Traffic-Monitor API.
80+
The **search** endpoint which provides the data for the HTTP Traffic overview, the **circuitpath** endpoint which provides the data for the Filter Execution Path as part of the detailed view of a transaction and the **trace** endpoint which returns the trace information. Currently the API Builder Project does not cover all endpoints to completely replace the existing Traffic Monitor API yet, but more endpoints will be added soon!_
8181
For search endpoint add: `http.request.path` matches regular expression `^\/api\/router\/service\/[A-Za-z0-9-.]+\/ops\/search$`
8282
For circuitpath endpoint add: `http.request.path` matches regular expression `^\/api\/router\/service\/[A-Za-z0-9-.]+\/ops\/stream\/[A-Za-z0-9]+\/[^\/]+\/circuitpath$`
83+
For trace endpoint add: `http.request.path` matches regular expression `^\/api\/router\/service\/[A-Za-z0-9-.]+\/ops\/trace\/[A-Za-z0-9]+[\?]?.*$`
8384
_The list of requests will be extended once the API-Builder project can serve more (e.g. the Request-Detail view)._
8485
![Is API Managed][img6]
8586
- Adjust the URL of the Connect to URL filter to your running API-Builder docker container and port - **default is 8889**. Sample: `http://api-env:8889/api/elk/v1${http.request.rawURI}`

‎elk-traffic-monitor-api/endpoints/trafficMonitorApi.json‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -182,6 +182,65 @@
182182
"required": true
183183
}
184184
]
185+
},
186+
"/router/service/{serviceID}/ops/trace/{correlationID}": {
187+
"parameters": [
188+
{
189+
"type": "string",
190+
"name": "serviceID",
191+
"in": "path",
192+
"required": true,
193+
"description": "instance of the API Gateway e.g.instance-1"
194+
},
195+
{
196+
"type": "string",
197+
"name": "correlationID",
198+
"in": "path",
199+
"required": true,
200+
"description": "identifies the transaction"
201+
}
202+
],
203+
"get": {
204+
"summary": "Retrieves trace information",
205+
"tags": [],
206+
"responses": {
207+
"200": {
208+
"description": "OK",
209+
"schema": {
210+
"type": "object",
211+
"properties": {}
212+
}
213+
},
214+
"500": {
215+
"description": "Internal Server Error",
216+
"schema": {
217+
"type": "object",
218+
"properties": {}
219+
}
220+
}
221+
},
222+
"operationId": "trace",
223+
"description": "Retrieves trace information associated to a transaction identified by its correlationID and serviceID",
224+
"parameters": [
225+
{
226+
"type": "string",
227+
"in": "query",
228+
"name": "format",
229+
"description": "describes the result format (only json is supported; if not applied it is defaulted to json anyway) "
230+
},
231+
{
232+
"type": "string",
233+
"in": "query",
234+
"name": "sentData"
235+
},
236+
{
237+
"type": "string",
238+
"in": "query",
239+
"name": "receivedData"
240+
}
241+
],
242+
"x-flow": "trafficMonitorApi-trace"
243+
}
185244
}
186245
},
187246
"basePath": "/elk/v1/api"

‎elk-traffic-monitor-api/flows/trafficMonitorApi-trace.json‎

Lines changed: 311 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,311 @@
1+
{
2+
"schemaVersion": "4",
3+
"info": {
4+
"name": "trafficMonitorApi - get /router/service/{serviceID}/ops/trace/{correlationID}"
5+
},
6+
"parameter": {
7+
"properties": {
8+
"params": {
9+
"type": "object",
10+
"description": "The parameters from the endpoint."
11+
},
12+
"request": {
13+
"type": "object",
14+
"description": "The HTTP request."
15+
},
16+
"config": {
17+
"type": "object",
18+
"description": "The service's configuration"
19+
},
20+
"env": {
21+
"type": "object",
22+
"description": "The host OS environment"
23+
}
24+
},
25+
"additionalProperties": false,
26+
"required": [
27+
"params",
28+
"request",
29+
"config",
30+
"env"
31+
]
32+
},
33+
"start": "javascript.4",
34+
"nodes": {
35+
"http.1": {
36+
"type": "nodehandler://axway-flow/http",
37+
"name": "Set HTTP Response",
38+
"method": "setresponse",
39+
"parameters": [
40+
{
41+
"name": "status",
42+
"type": "number",
43+
"value": "200",
44+
"metaName": "status",
45+
"metaDescription": "The HTTP status code"
46+
},
47+
{
48+
"name": "body",
49+
"type": "jsonpath",
50+
"value": "$.result",
51+
"metaName": "body",
52+
"metaDescription": "The response payload"
53+
}
54+
],
55+
"outputs": {
56+
"next": {
57+
"context": "$.response",
58+
"routes": [],
59+
"metaName": "Next"
60+
}
61+
},
62+
"metaMethod": "Set HTTP Response"
63+
},
64+
"elasticsearch.1": {
65+
"type": "nodehandler://@axway-api-builder-ext/api-builder-plugin-fn-elasticsearch/elasticsearch",
66+
"name": "Search trace",
67+
"method": "search",
68+
"parameters": [
69+
{
70+
"name": "query",
71+
"type": "jsonpath",
72+
"value": "$.elasticsearch.query",
73+
"metaName": "query",
74+
"metaDescription": "Defines the search definition using the Query DSL. Learn more: https://www.elastic.co/guide/en/elasticsearch/reference/7.x/query-dsl.html"
75+
},
76+
{
77+
"name": "size",
78+
"type": "number",
79+
"value": "10000",
80+
"metaName": "size",
81+
"metaDescription": "Defines the number of hits to return. Defaults to 10."
82+
},
83+
{
84+
"name": "index",
85+
"type": "jsonpath",
86+
"value": "$.index",
87+
"metaName": "index",
88+
"metaDescription": "Comma-separated list or wildcard expression of index names used to limit the request."
89+
}
90+
],
91+
"outputs": {
92+
"next": {
93+
"context": "$.elasticsearch.result",
94+
"routes": [
95+
"javascript.1"
96+
],
97+
"metaName": "Next"
98+
},
99+
"error": {
100+
"context": "$.error",
101+
"routes": [
102+
"http.2"
103+
],
104+
"metaName": "Error"
105+
}
106+
},
107+
"metaMethod": "Search"
108+
},
109+
"javascript.1": {
110+
"type": "nodehandler://@axway/api-builder-plugin-fn-javascript/javascript",
111+
"name": "Format response",
112+
"method": "Execute",
113+
"parameters": [
114+
{
115+
"name": "data",
116+
"type": "jsonpath",
117+
"value": "$.elasticsearch.result.body.hits",
118+
"metaName": "data",
119+
"metaDescription": "The value to apply as the `data` argument to the JavaScript code. For objects and arrays, `data` is passed by reference."
120+
},
121+
{
122+
"name": "code",
123+
"type": "string",
124+
"value": "\"let result = [];\\n \\n data.hits.map(function(entry) {\\n let traceObj = {};\\n let message = entry._source.message;\\n let dateObj = isoStringToDate(entry._source.timestampOriginal);\\n let dateObj2 = parseDate(entry._source.timestampOriginal);\\n\\t\\n // depth is the number of tabs befor start of the message. \\n // Calculated based on count of white spaces divided by 4\\n const depthRegex = /(?<=[\\\\]])\\\\s*/gm;\\n let depthMatch = depthRegex.exec(message);\\n\\tlet depth = 1;\\n \\n if (depthMatch !== null){\\n depth = Math.round(depthMatch[0].length/4);\\n }\\n \\n traceObj.level = entry._source.level;\\n traceObj.type = 'trace';\\n traceObj.time = dateObj.getTime();\\n traceObj.depth = depth;\\n traceObj.text = message.substring(message.lastIndexOf(\\\"]\\\")+1,message.length).trim();\\n \\n result.push(traceObj);\\n \\n });\\n\\n \\nfunction parseDate(input) {\\n var parts = input.match(/(\\\\d+)/g);\\n // new Date(year, month [, date [, hours[, minutes[, seconds[, ms]]]]])\\n return new Date(parts[0], parts[1]-1, parts[2]); // months are 0-based\\n}\\n\\n // Parse an ISO date string (i.e. \\\"2019-01-18T00:00:00.000Z\\\",\\n// \\\"2019-01-17T17:00:00.000-07:00\\\", or \\\"2019-01-18T07:00:00.000+07:00\\\",\\n// which are the same time) and return a JavaScript Date object with the\\n// value represented by the string.\\nfunction isoStringToDate( isoString ) {\\n\\n // Split the string into an array based on the digit groups.\\n var dateParts = isoString.split( /\\\\D+/ );\\n\\n // Set up a date object with the current time.\\n var returnDate = new Date();\\n\\n // Manually parse the parts of the string and set each part for the\\n // date. Note: Using the UTC versions of these functions is necessary\\n // because we're manually adjusting for time zones stored in the\\n // string.\\n returnDate.setUTCFullYear( parseInt( dateParts[ 0 ] ) );\\n\\n // The month numbers are one \\\"off\\\" from what normal humans would expect\\n // because January == 0.\\n returnDate.setUTCMonth( parseInt( dateParts[ 1 ] - 1 ) );\\n returnDate.setUTCDate( parseInt( dateParts[ 2 ] ) );\\n\\n // Set the time parts of the date object.\\n returnDate.setUTCHours( parseInt( dateParts[ 3 ] ) );\\n returnDate.setUTCMinutes( parseInt( dateParts[ 4 ] ) );\\n returnDate.setUTCSeconds( parseInt( dateParts[ 5 ] ) );\\n returnDate.setUTCMilliseconds( parseInt( dateParts[ 6 ] ) );\\n\\n // Track the number of hours we need to adjust the date by based\\n // on the timezone.\\n var timezoneOffsetHours = 0;\\n\\n // If there's a value for either the hours or minutes offset.\\n if ( dateParts[ 7 ] || dateParts[ 8 ] ) {\\n\\n // Track the number of minutes we need to adjust the date by\\n // based on the timezone.\\n var timezoneOffsetMinutes = 0;\\n\\n // If there's a value for the minutes offset.\\n if ( dateParts[ 8 ] ) {\\n\\n // Convert the minutes value into an hours value.\\n timezoneOffsetMinutes = parseInt( dateParts[ 8 ] ) / 60;\\n }\\n\\n // Add the hours and minutes values to get the total offset in\\n // hours.\\n timezoneOffsetHours = parseInt( dateParts[ 7 ] ) + timezoneOffsetMinutes;\\n\\n // If the sign for the timezone is a plus to indicate the\\n // timezone is ahead of UTC time.\\n if ( isoString.substr( -6, 1 ) == \\\"+\\\" ) {\\n\\n // Make the offset negative since the hours will need to be\\n // subtracted from the date.\\n timezoneOffsetHours *= -1;\\n }\\n }\\n\\n // Get the current hours for the date and add the offset to get the\\n // correct time adjusted for timezone.\\n returnDate.setHours( returnDate.getHours() + timezoneOffsetHours );\\n\\n // Return the Date object calculated from the string.\\n return returnDate;\\n}\\n \\n return result;\"",
125+
"metaName": "code",
126+
"metaDescription": "A JavaScript function body. Supports `await` and returning promises"
127+
}
128+
],
129+
"outputs": {
130+
"next": {
131+
"context": "$.result",
132+
"routes": [
133+
"http.1"
134+
],
135+
"metaName": "Next"
136+
},
137+
"error": {
138+
"context": "$.error",
139+
"routes": [
140+
"http.2"
141+
],
142+
"metaName": "Error"
143+
}
144+
},
145+
"metaMethod": "Execute"
146+
},
147+
"javascript.2": {
148+
"type": "nodehandler://@axway/api-builder-plugin-fn-javascript/javascript",
149+
"name": "Build ES query",
150+
"method": "Execute",
151+
"parameters": [
152+
{
153+
"name": "data",
154+
"type": "jsonpath",
155+
"value": "$",
156+
"metaName": "data",
157+
"metaDescription": "The value to apply as the `data` argument to the JavaScript code. For objects and arrays, `data` is passed by reference."
158+
},
159+
{
160+
"name": "code",
161+
"type": "string",
162+
"value": "\"let elasticQuery = ({\\n \\\"bool\\\": {\\n \\\"must\\\": [\\n {\\\"term\\\": {\\n \\\"correlationId\\\": data.params.correlationID\\n }\\n }\\n ]\\n }\\n });\\n\\n return elasticQuery;\"",
163+
"metaName": "code",
164+
"metaDescription": "A JavaScript function body. Supports `await` and returning promises"
165+
}
166+
],
167+
"outputs": {
168+
"next": {
169+
"context": "$.elasticsearch.query",
170+
"routes": [
171+
"elasticsearch.1"
172+
],
173+
"metaName": "Next"
174+
},
175+
"error": {
176+
"context": "$.error",
177+
"routes": [
178+
"http.2"
179+
],
180+
"metaName": "Error"
181+
}
182+
},
183+
"metaMethod": "Execute"
184+
},
185+
"http.2": {
186+
"type": "nodehandler://axway-flow/http",
187+
"name": "Set HTTP 500 Error Response",
188+
"method": "setresponse",
189+
"parameters": [
190+
{
191+
"name": "status",
192+
"type": "number",
193+
"value": "500",
194+
"metaName": "status",
195+
"metaDescription": "The HTTP status code"
196+
}
197+
],
198+
"outputs": {
199+
"next": {
200+
"context": "$.response",
201+
"routes": [],
202+
"metaName": "Next"
203+
}
204+
},
205+
"metaMethod": "Set HTTP Response"
206+
},
207+
"javascript.3": {
208+
"type": "nodehandler://@axway/api-builder-plugin-fn-javascript/javascript",
209+
"name": "Check Params",
210+
"method": "Execute",
211+
"parameters": [
212+
{
213+
"name": "data",
214+
"type": "jsonpath",
215+
"value": "$",
216+
"metaName": "data",
217+
"metaDescription": "The value to apply as the `data` argument to the JavaScript code. For objects and arrays, `data` is passed by reference."
218+
},
219+
{
220+
"name": "code",
221+
"type": "string",
222+
"value": "\"//only json is supported. \\n //If param format is skipped automatically json is returned\\n if(data.params.format != undefined && data.params.format != 'json') {\\n throw {\\n name: \\\"unknown format exception\\\",\\n message: \\\"unknown format\\\"\\n };\\n }\"",
223+
"metaName": "code",
224+
"metaDescription": "A JavaScript function body. Supports `await` and returning promises"
225+
}
226+
],
227+
"outputs": {
228+
"next": {
229+
"context": "$.result",
230+
"routes": [
231+
"javascript.2"
232+
],
233+
"metaName": "Next"
234+
},
235+
"error": {
236+
"context": "$.error",
237+
"routes": [
238+
"http.3"
239+
],
240+
"metaName": "Error"
241+
}
242+
},
243+
"metaMethod": "Execute"
244+
},
245+
"http.3": {
246+
"type": "nodehandler://axway-flow/http",
247+
"name": "Set HTTP 400 Response",
248+
"method": "setresponse",
249+
"parameters": [
250+
{
251+
"name": "status",
252+
"type": "number",
253+
"value": "400",
254+
"metaName": "status",
255+
"metaDescription": "The HTTP status code"
256+
},
257+
{
258+
"name": "body",
259+
"type": "jsonpath",
260+
"value": "$.error.message",
261+
"metaName": "body",
262+
"metaDescription": "The response payload"
263+
}
264+
],
265+
"outputs": {
266+
"next": {
267+
"context": "$.response",
268+
"routes": [],
269+
"metaName": "Next"
270+
}
271+
},
272+
"metaMethod": "Set HTTP Response"
273+
},
274+
"javascript.4": {
275+
"type": "nodehandler://@axway/api-builder-plugin-fn-javascript/javascript",
276+
"name": "Define Index",
277+
"method": "Execute",
278+
"parameters": [
279+
{
280+
"name": "code",
281+
"type": "string",
282+
"value": "\"let index = 'logstash-trace';\\n if(data.config.testElasticIndex) {\\n index = data.config.testElasticIndex;\\n }\\n return index;\"",
283+
"metaName": "code",
284+
"metaDescription": "A JavaScript function body. Supports `await` and returning promises"
285+
},
286+
{
287+
"name": "data",
288+
"type": "jsonpath",
289+
"value": "$",
290+
"metaName": "data",
291+
"metaDescription": "The value to apply as the `data` argument to the JavaScript code. For objects and arrays, `data` is passed by reference."
292+
}
293+
],
294+
"outputs": {
295+
"next": {
296+
"context": "$.index",
297+
"routes": [
298+
"javascript.3"
299+
],
300+
"metaName": "Next"
301+
},
302+
"error": {
303+
"context": "$.error",
304+
"routes": [],
305+
"metaName": "Error"
306+
}
307+
},
308+
"metaMethod": "Execute"
309+
}
310+
}
311+
}

0 commit comments

Comments
 (0)