@itentialopensource/adapter-splunk 0.4.0 → 0.4.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CALLS.md +9 -9
- package/CHANGELOG.md +16 -0
- package/adapter.js +46 -34
- package/entities/Services/action.json +44 -29
- package/entities/Services/schema.json +1 -1
- package/package.json +3 -3
- package/pronghorn.json +88 -0
- package/refs?service=git-upload-pack +0 -0
- package/report/adapterInfo.json +7 -7
- package/test/unit/adapterTestUnit.js +3 -105
package/CALLS.md
CHANGED
|
@@ -337,7 +337,7 @@ Specific adapter calls are built based on the API of the Splunk. The Adapter Bui
|
|
|
337
337
|
<tr>
|
|
338
338
|
<td style="padding:15px">postSearchJobsExport(body, callback)</td>
|
|
339
339
|
<td style="padding:15px">postSearchJobsExport</td>
|
|
340
|
-
<td style="padding:15px">{base_path}/{version}/services/search/jobs/export?{query}</td>
|
|
340
|
+
<td style="padding:15px">v1:{base_path}/{version}/services/search/jobs/export?{query} <br /> v2:{base_path}/{version}/services/search/v2/jobs/export?{query}</td>
|
|
341
341
|
<td style="padding:15px">Yes</td>
|
|
342
342
|
</tr>
|
|
343
343
|
<tr>
|
|
@@ -367,19 +367,19 @@ Specific adapter calls are built based on the API of the Splunk. The Adapter Bui
|
|
|
367
367
|
<tr>
|
|
368
368
|
<td style="padding:15px">getSearchJobsByIdEvents(searchId, count, maxLines, outputMode, truncationMode, callback)</td>
|
|
369
369
|
<td style="padding:15px">getSearchJobsByIdEvents</td>
|
|
370
|
-
<td style="padding:15px">{base_path}/{version}/services/search/jobs/{pathv1}/events?{query}</td>
|
|
370
|
+
<td style="padding:15px">v1:{base_path}/{version}/services/search/jobs/{pathv1}/events?{query} <br /> v2:{base_path}/services/search/v2/jobs/{pathv1}/events?{query}</td>
|
|
371
371
|
<td style="padding:15px">Yes</td>
|
|
372
372
|
</tr>
|
|
373
373
|
<tr>
|
|
374
|
-
<td style="padding:15px">
|
|
375
|
-
<td style="padding:15px">getSearchJobsByIdResults</td>
|
|
376
|
-
<td style="padding:15px">{base_path}/{version}/services/search/jobs/{pathv1}/results?{query}</td>
|
|
374
|
+
<td style="padding:15px">getSearchJobsByIdResultsWithOptions(searchId, queryData, callback)</td>
|
|
375
|
+
<td style="padding:15px">getSearchJobsByIdResults with query data</td>
|
|
376
|
+
<td style="padding:15px">v1:{base_path}/{version}/services/search/jobs/{pathv1}/results?{query} <br /> v2:{base_path}/services/search/v2/jobs/{pathv1}/results?{query}</td>
|
|
377
377
|
<td style="padding:15px">Yes</td>
|
|
378
378
|
</tr>
|
|
379
379
|
<tr>
|
|
380
|
-
<td style="padding:15px">
|
|
381
|
-
<td style="padding:15px">
|
|
382
|
-
<td style="padding:15px">{base_path}/{version}/services/search/jobs/{pathv1}/results_preview?{query}</td>
|
|
380
|
+
<td style="padding:15px">getSearchJobsByIdResultsPreviewWithOptions(searchId, queryData, callback)</td>
|
|
381
|
+
<td style="padding:15px">getSearchJobsByIdResultsPreviewWithOptions</td>
|
|
382
|
+
<td style="padding:15px">v1:{base_path}/{version}/services/search/jobs/{pathv1}/results_preview?{query} <br /> v2:{base_path}/services/search/v2/jobs/{pathv1}/results_preview?{query}</td>
|
|
383
383
|
<td style="padding:15px">Yes</td>
|
|
384
384
|
</tr>
|
|
385
385
|
<tr>
|
|
@@ -403,7 +403,7 @@ Specific adapter calls are built based on the API of the Splunk. The Adapter Bui
|
|
|
403
403
|
<tr>
|
|
404
404
|
<td style="padding:15px">getSearchParser(q, callback)</td>
|
|
405
405
|
<td style="padding:15px">getSearchParser</td>
|
|
406
|
-
<td style="padding:15px">{base_path}/{version}/services/search/parser?{query}</td>
|
|
406
|
+
<td style="padding:15px">v1:{base_path}/{version}/services/search/parser?{query} <br /> v2:{base_path}/services/search/v2/parser?{query}</td>
|
|
407
407
|
<td style="padding:15px">Yes</td>
|
|
408
408
|
</tr>
|
|
409
409
|
<tr>
|
package/CHANGELOG.md
CHANGED
|
@@ -1,4 +1,20 @@
|
|
|
1
1
|
|
|
2
|
+
## 0.4.2 [12-20-2023]
|
|
3
|
+
|
|
4
|
+
* Add v2 endpoints and add tasks with query data
|
|
5
|
+
|
|
6
|
+
See merge request itentialopensource/adapters/telemetry-analytics/adapter-splunk!4
|
|
7
|
+
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
## 0.4.1 [12-01-2023]
|
|
11
|
+
|
|
12
|
+
* Update request data types to URLENCODE for post calls
|
|
13
|
+
|
|
14
|
+
See merge request itentialopensource/adapters/telemetry-analytics/adapter-splunk!3
|
|
15
|
+
|
|
16
|
+
---
|
|
17
|
+
|
|
2
18
|
## 0.4.0 [11-07-2023]
|
|
3
19
|
|
|
4
20
|
* More migration changes
|
package/adapter.js
CHANGED
|
@@ -3409,7 +3409,28 @@ class Splunk extends AdapterBaseCl {
|
|
|
3409
3409
|
*/
|
|
3410
3410
|
/* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
|
|
3411
3411
|
getSearchJobsByIdResults(searchId, count, addSummaryToMetadata, search, callback) {
|
|
3412
|
-
const
|
|
3412
|
+
const queryData = { count, addSummaryToMetadata, search };
|
|
3413
|
+
this.getSearchJobsByIdResultsWithOptions(searchId, queryData, callback);
|
|
3414
|
+
}
|
|
3415
|
+
|
|
3416
|
+
/**
|
|
3417
|
+
* @function getSearchJobsByIdResultsWithOptions
|
|
3418
|
+
* @pronghornType method
|
|
3419
|
+
* @name getSearchJobsByIdResultsWithOptions
|
|
3420
|
+
* @summary getSearchJobsByIdResultsWithOptions
|
|
3421
|
+
*
|
|
3422
|
+
* @param {string} searchId - search_id
|
|
3423
|
+
* @param {object} queryData - object of query data - addSummaryToMetadata, count, outputMode, f, offset
|
|
3424
|
+
* @param {getCallback} callback - a callback function to return the result
|
|
3425
|
+
* @return {object} results - An object containing the response of the action
|
|
3426
|
+
*
|
|
3427
|
+
* @route {POST} /getSearchJobsByIdResultsWithOptions
|
|
3428
|
+
* @roles admin
|
|
3429
|
+
* @task true
|
|
3430
|
+
*/
|
|
3431
|
+
/* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
|
|
3432
|
+
getSearchJobsByIdResultsWithOptions(searchId, queryData, callback) {
|
|
3433
|
+
const meth = 'adapter-getSearchJobsByIdResultsWithOptions';
|
|
3413
3434
|
const origin = `${this.id}-${meth}`;
|
|
3414
3435
|
log.trace(origin);
|
|
3415
3436
|
|
|
@@ -3425,24 +3446,9 @@ class Splunk extends AdapterBaseCl {
|
|
|
3425
3446
|
log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
|
|
3426
3447
|
return callback(null, errorObj);
|
|
3427
3448
|
}
|
|
3428
|
-
if (count === undefined || count === null || count === '') {
|
|
3429
|
-
const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['count'], null, null, null);
|
|
3430
|
-
log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
|
|
3431
|
-
return callback(null, errorObj);
|
|
3432
|
-
}
|
|
3433
|
-
if (addSummaryToMetadata === undefined || addSummaryToMetadata === null || addSummaryToMetadata === '') {
|
|
3434
|
-
const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['addSummaryToMetadata'], null, null, null);
|
|
3435
|
-
log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
|
|
3436
|
-
return callback(null, errorObj);
|
|
3437
|
-
}
|
|
3438
|
-
if (search === undefined || search === null || search === '') {
|
|
3439
|
-
const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['search'], null, null, null);
|
|
3440
|
-
log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
|
|
3441
|
-
return callback(null, errorObj);
|
|
3442
|
-
}
|
|
3443
3449
|
|
|
3444
3450
|
/* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
|
|
3445
|
-
const queryParamsAvailable =
|
|
3451
|
+
const queryParamsAvailable = queryData;
|
|
3446
3452
|
const queryParams = {};
|
|
3447
3453
|
const pathVars = [searchId];
|
|
3448
3454
|
const bodyVars = {};
|
|
@@ -3509,7 +3515,28 @@ class Splunk extends AdapterBaseCl {
|
|
|
3509
3515
|
*/
|
|
3510
3516
|
/* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
|
|
3511
3517
|
getSearchJobsByIdResultsPreview(searchId, count, addSummaryToMetadata, search, callback) {
|
|
3512
|
-
const
|
|
3518
|
+
const queryData = { count, addSummaryToMetadata, search };
|
|
3519
|
+
this.getSearchJobsByIdResultsPreviewWithOptions(searchId, queryData, callback);
|
|
3520
|
+
}
|
|
3521
|
+
|
|
3522
|
+
/**
|
|
3523
|
+
* @function getSearchJobsByIdResultsPreviewWithOptions
|
|
3524
|
+
* @pronghornType method
|
|
3525
|
+
* @name getSearchJobsByIdResultsPreviewWithOptions
|
|
3526
|
+
* @summary getSearchJobsByIdResultsPreviewWithOptions
|
|
3527
|
+
*
|
|
3528
|
+
* @param {string} searchId - search_id
|
|
3529
|
+
* @param {object} queryData - object of query data - addSummaryToMetadata, count, f, offset, outputMode
|
|
3530
|
+
* @param {getCallback} callback - a callback function to return the result
|
|
3531
|
+
* @return {object} results - An object containing the response of the action
|
|
3532
|
+
*
|
|
3533
|
+
* @route {POST} /getSearchJobsByIdResultsPreviewWithOptions
|
|
3534
|
+
* @roles admin
|
|
3535
|
+
* @task true
|
|
3536
|
+
*/
|
|
3537
|
+
/* YOU CAN CHANGE THE PARAMETERS YOU TAKE IN HERE AND IN THE pronghorn.json FILE */
|
|
3538
|
+
getSearchJobsByIdResultsPreviewWithOptions(searchId, queryData, callback) {
|
|
3539
|
+
const meth = 'adapter-getSearchJobsByIdResultsPreviewWithOptions';
|
|
3513
3540
|
const origin = `${this.id}-${meth}`;
|
|
3514
3541
|
log.trace(origin);
|
|
3515
3542
|
|
|
@@ -3525,24 +3552,9 @@ class Splunk extends AdapterBaseCl {
|
|
|
3525
3552
|
log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
|
|
3526
3553
|
return callback(null, errorObj);
|
|
3527
3554
|
}
|
|
3528
|
-
if (count === undefined || count === null || count === '') {
|
|
3529
|
-
const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['count'], null, null, null);
|
|
3530
|
-
log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
|
|
3531
|
-
return callback(null, errorObj);
|
|
3532
|
-
}
|
|
3533
|
-
if (addSummaryToMetadata === undefined || addSummaryToMetadata === null || addSummaryToMetadata === '') {
|
|
3534
|
-
const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['addSummaryToMetadata'], null, null, null);
|
|
3535
|
-
log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
|
|
3536
|
-
return callback(null, errorObj);
|
|
3537
|
-
}
|
|
3538
|
-
if (search === undefined || search === null || search === '') {
|
|
3539
|
-
const errorObj = this.requestHandlerInst.formatErrorObject(this.id, meth, 'Missing Data', ['search'], null, null, null);
|
|
3540
|
-
log.error(`${origin}: ${errorObj.IAPerror.displayString}`);
|
|
3541
|
-
return callback(null, errorObj);
|
|
3542
|
-
}
|
|
3543
3555
|
|
|
3544
3556
|
/* HERE IS WHERE YOU SET THE DATA TO PASS INTO REQUEST */
|
|
3545
|
-
const queryParamsAvailable =
|
|
3557
|
+
const queryParamsAvailable = queryData;
|
|
3546
3558
|
const queryParams = {};
|
|
3547
3559
|
const pathVars = [searchId];
|
|
3548
3560
|
const bodyVars = {};
|
|
@@ -92,8 +92,8 @@
|
|
|
92
92
|
"responseSchema": "schema.json",
|
|
93
93
|
"timeout": 0,
|
|
94
94
|
"sendEmpty": false,
|
|
95
|
-
"requestDatatype": "
|
|
96
|
-
"responseDatatype": "
|
|
95
|
+
"requestDatatype": "URLENCODE",
|
|
96
|
+
"responseDatatype": "XML2JSON",
|
|
97
97
|
"headers": {},
|
|
98
98
|
"responseObjects": [
|
|
99
99
|
{
|
|
@@ -112,8 +112,8 @@
|
|
|
112
112
|
"responseSchema": "schema.json",
|
|
113
113
|
"timeout": 0,
|
|
114
114
|
"sendEmpty": false,
|
|
115
|
-
"requestDatatype": "
|
|
116
|
-
"responseDatatype": "
|
|
115
|
+
"requestDatatype": "URLENCODE",
|
|
116
|
+
"responseDatatype": "XML2JSON",
|
|
117
117
|
"headers": {},
|
|
118
118
|
"responseObjects": [
|
|
119
119
|
{
|
|
@@ -132,8 +132,8 @@
|
|
|
132
132
|
"responseSchema": "schema.json",
|
|
133
133
|
"timeout": 0,
|
|
134
134
|
"sendEmpty": false,
|
|
135
|
-
"requestDatatype": "
|
|
136
|
-
"responseDatatype": "
|
|
135
|
+
"requestDatatype": "URLENCODE",
|
|
136
|
+
"responseDatatype": "XML2JSON",
|
|
137
137
|
"headers": {},
|
|
138
138
|
"responseObjects": [
|
|
139
139
|
{
|
|
@@ -173,8 +173,8 @@
|
|
|
173
173
|
"responseSchema": "schema.json",
|
|
174
174
|
"timeout": 0,
|
|
175
175
|
"sendEmpty": false,
|
|
176
|
-
"requestDatatype": "
|
|
177
|
-
"responseDatatype": "
|
|
176
|
+
"requestDatatype": "URLENCODE",
|
|
177
|
+
"responseDatatype": "XML2JSON",
|
|
178
178
|
"headers": {},
|
|
179
179
|
"responseObjects": [
|
|
180
180
|
{
|
|
@@ -297,8 +297,8 @@
|
|
|
297
297
|
"responseSchema": "schema.json",
|
|
298
298
|
"timeout": 0,
|
|
299
299
|
"sendEmpty": false,
|
|
300
|
-
"requestDatatype": "
|
|
301
|
-
"responseDatatype": "
|
|
300
|
+
"requestDatatype": "URLENCODE",
|
|
301
|
+
"responseDatatype": "XML2JSON",
|
|
302
302
|
"headers": {},
|
|
303
303
|
"responseObjects": [
|
|
304
304
|
{
|
|
@@ -317,8 +317,8 @@
|
|
|
317
317
|
"responseSchema": "schema.json",
|
|
318
318
|
"timeout": 0,
|
|
319
319
|
"sendEmpty": false,
|
|
320
|
-
"requestDatatype": "
|
|
321
|
-
"responseDatatype": "
|
|
320
|
+
"requestDatatype": "URLENCODE",
|
|
321
|
+
"responseDatatype": "XML2JSON",
|
|
322
322
|
"headers": {},
|
|
323
323
|
"responseObjects": [
|
|
324
324
|
{
|
|
@@ -358,8 +358,8 @@
|
|
|
358
358
|
"responseSchema": "schema.json",
|
|
359
359
|
"timeout": 0,
|
|
360
360
|
"sendEmpty": false,
|
|
361
|
-
"requestDatatype": "
|
|
362
|
-
"responseDatatype": "
|
|
361
|
+
"requestDatatype": "URLENCODE",
|
|
362
|
+
"responseDatatype": "XML2JSON",
|
|
363
363
|
"headers": {},
|
|
364
364
|
"responseObjects": [
|
|
365
365
|
{
|
|
@@ -420,8 +420,8 @@
|
|
|
420
420
|
"responseSchema": "schema.json",
|
|
421
421
|
"timeout": 0,
|
|
422
422
|
"sendEmpty": false,
|
|
423
|
-
"requestDatatype": "
|
|
424
|
-
"responseDatatype": "
|
|
423
|
+
"requestDatatype": "URLENCODE",
|
|
424
|
+
"responseDatatype": "XML2JSON",
|
|
425
425
|
"headers": {},
|
|
426
426
|
"responseObjects": [
|
|
427
427
|
{
|
|
@@ -456,13 +456,16 @@
|
|
|
456
456
|
"name": "postSearchJobsExport",
|
|
457
457
|
"protocol": "REST",
|
|
458
458
|
"method": "POST",
|
|
459
|
-
"entitypath":
|
|
459
|
+
"entitypath": {
|
|
460
|
+
"v1": "{base_path}/{version}/services/search/jobs/export?{query}",
|
|
461
|
+
"v2": "{base_path}/{version}/services/search/v2/jobs/export?{query}"
|
|
462
|
+
},
|
|
460
463
|
"requestSchema": "schema.json",
|
|
461
464
|
"responseSchema": "schema.json",
|
|
462
465
|
"timeout": 0,
|
|
463
466
|
"sendEmpty": false,
|
|
464
|
-
"requestDatatype": "
|
|
465
|
-
"responseDatatype": "
|
|
467
|
+
"requestDatatype": "URLENCODE",
|
|
468
|
+
"responseDatatype": "XML2JSON",
|
|
466
469
|
"headers": {},
|
|
467
470
|
"responseObjects": [
|
|
468
471
|
{
|
|
@@ -522,8 +525,8 @@
|
|
|
522
525
|
"responseSchema": "schema.json",
|
|
523
526
|
"timeout": 0,
|
|
524
527
|
"sendEmpty": false,
|
|
525
|
-
"requestDatatype": "
|
|
526
|
-
"responseDatatype": "
|
|
528
|
+
"requestDatatype": "URLENCODE",
|
|
529
|
+
"responseDatatype": "XML2JSON",
|
|
527
530
|
"headers": {},
|
|
528
531
|
"responseObjects": [
|
|
529
532
|
{
|
|
@@ -542,8 +545,8 @@
|
|
|
542
545
|
"responseSchema": "schema.json",
|
|
543
546
|
"timeout": 0,
|
|
544
547
|
"sendEmpty": false,
|
|
545
|
-
"requestDatatype": "
|
|
546
|
-
"responseDatatype": "
|
|
548
|
+
"requestDatatype": "URLENCODE",
|
|
549
|
+
"responseDatatype": "XML2JSON",
|
|
547
550
|
"headers": {},
|
|
548
551
|
"responseObjects": [
|
|
549
552
|
{
|
|
@@ -557,7 +560,10 @@
|
|
|
557
560
|
"name": "getSearchJobsByIdEvents",
|
|
558
561
|
"protocol": "REST",
|
|
559
562
|
"method": "GET",
|
|
560
|
-
"entitypath":
|
|
563
|
+
"entitypath": {
|
|
564
|
+
"v1": "{base_path}/{version}/services/search/jobs/{pathv1}/events?{query}",
|
|
565
|
+
"v2": "{base_path}/services/search/v2/jobs/{pathv1}/events?{query}"
|
|
566
|
+
},
|
|
561
567
|
"requestSchema": "schema.json",
|
|
562
568
|
"responseSchema": "schema.json",
|
|
563
569
|
"timeout": 0,
|
|
@@ -578,7 +584,10 @@
|
|
|
578
584
|
"name": "getSearchJobsByIdResults",
|
|
579
585
|
"protocol": "REST",
|
|
580
586
|
"method": "GET",
|
|
581
|
-
"entitypath":
|
|
587
|
+
"entitypath": {
|
|
588
|
+
"v1": "{base_path}/{version}/services/search/jobs/{pathv1}/results?{query}",
|
|
589
|
+
"v2": "{base_path}/services/search/v2/jobs/{pathv1}/results?{query}"
|
|
590
|
+
},
|
|
582
591
|
"requestSchema": "schema.json",
|
|
583
592
|
"responseSchema": "schema.json",
|
|
584
593
|
"timeout": 0,
|
|
@@ -599,7 +608,10 @@
|
|
|
599
608
|
"name": "getSearchJobsByIdResultsPreview",
|
|
600
609
|
"protocol": "REST",
|
|
601
610
|
"method": "GET",
|
|
602
|
-
"entitypath":
|
|
611
|
+
"entitypath": {
|
|
612
|
+
"v1": "{base_path}/{version}/services/search/jobs/{pathv1}/results_preview?{query}",
|
|
613
|
+
"v2": "{base_path}/services/search/v2/jobs/{pathv1}/results_preview?{query}"
|
|
614
|
+
},
|
|
603
615
|
"requestSchema": "schema.json",
|
|
604
616
|
"responseSchema": "schema.json",
|
|
605
617
|
"timeout": 0,
|
|
@@ -683,7 +695,10 @@
|
|
|
683
695
|
"name": "getSearchParser",
|
|
684
696
|
"protocol": "REST",
|
|
685
697
|
"method": "GET",
|
|
686
|
-
"entitypath":
|
|
698
|
+
"entitypath": {
|
|
699
|
+
"v1": "{base_path}/{version}/services/search/parser?{query}",
|
|
700
|
+
"v2": "{base_path}/services/search/v2/parser?{query}"
|
|
701
|
+
},
|
|
687
702
|
"requestSchema": "schema.json",
|
|
688
703
|
"responseSchema": "schema.json",
|
|
689
704
|
"timeout": 0,
|
|
@@ -730,8 +745,8 @@
|
|
|
730
745
|
"responseSchema": "schema.json",
|
|
731
746
|
"timeout": 0,
|
|
732
747
|
"sendEmpty": false,
|
|
733
|
-
"requestDatatype": "
|
|
734
|
-
"responseDatatype": "
|
|
748
|
+
"requestDatatype": "URLENCODE",
|
|
749
|
+
"responseDatatype": "XML2JSON",
|
|
735
750
|
"headers": {},
|
|
736
751
|
"responseObjects": [
|
|
737
752
|
{
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@itentialopensource/adapter-splunk",
|
|
3
|
-
"version": "0.4.
|
|
3
|
+
"version": "0.4.2",
|
|
4
4
|
"description": "This adapter integrates with system described as: splunkAdapter.",
|
|
5
5
|
"main": "adapter.js",
|
|
6
6
|
"systemName": "Splunk",
|
|
@@ -55,10 +55,10 @@
|
|
|
55
55
|
"author": "Itential",
|
|
56
56
|
"homepage": "https://gitlab.com/itentialopensource/adapters/telemetry-analytics/adapter-splunk#readme",
|
|
57
57
|
"dependencies": {
|
|
58
|
-
"@itentialopensource/adapter-utils": "^5.3.
|
|
58
|
+
"@itentialopensource/adapter-utils": "^5.3.2",
|
|
59
59
|
"acorn": "^8.10.0",
|
|
60
60
|
"ajv": "^8.12.0",
|
|
61
|
-
"axios": "^1.
|
|
61
|
+
"axios": "^1.6.2",
|
|
62
62
|
"commander": "^11.0.0",
|
|
63
63
|
"dns-lookup-promise": "^1.0.4",
|
|
64
64
|
"fs-extra": "^11.1.1",
|
package/pronghorn.json
CHANGED
|
@@ -2477,6 +2477,50 @@
|
|
|
2477
2477
|
},
|
|
2478
2478
|
"task": true
|
|
2479
2479
|
},
|
|
2480
|
+
{
|
|
2481
|
+
"name": "getSearchJobsByIdResultsWithOptions",
|
|
2482
|
+
"summary": "getSearchJobsByIdResults with query data",
|
|
2483
|
+
"description": "getSearchJobsByIdResults with query data",
|
|
2484
|
+
"input": [
|
|
2485
|
+
{
|
|
2486
|
+
"name": "searchId",
|
|
2487
|
+
"type": "string",
|
|
2488
|
+
"info": "search_id: string",
|
|
2489
|
+
"required": true,
|
|
2490
|
+
"schema": {
|
|
2491
|
+
"title": "searchId",
|
|
2492
|
+
"type": "string"
|
|
2493
|
+
}
|
|
2494
|
+
},
|
|
2495
|
+
{
|
|
2496
|
+
"name": "queryData",
|
|
2497
|
+
"type": "object",
|
|
2498
|
+
"info": "query options object (e.g. addSummaryToMetadata, count, outputMode, f, offset)",
|
|
2499
|
+
"required": false,
|
|
2500
|
+
"schema": {
|
|
2501
|
+
"title": "queryData",
|
|
2502
|
+
"type": "object"
|
|
2503
|
+
}
|
|
2504
|
+
}
|
|
2505
|
+
],
|
|
2506
|
+
"output": {
|
|
2507
|
+
"name": "result",
|
|
2508
|
+
"type": "object",
|
|
2509
|
+
"description": "A JSON Object containing status, code and the result",
|
|
2510
|
+
"schema": {
|
|
2511
|
+
"title": "result",
|
|
2512
|
+
"type": "object"
|
|
2513
|
+
}
|
|
2514
|
+
},
|
|
2515
|
+
"roles": [
|
|
2516
|
+
"admin"
|
|
2517
|
+
],
|
|
2518
|
+
"route": {
|
|
2519
|
+
"verb": "POST",
|
|
2520
|
+
"path": "/getSearchJobsByIdResultsWithOptions"
|
|
2521
|
+
},
|
|
2522
|
+
"task": true
|
|
2523
|
+
},
|
|
2480
2524
|
{
|
|
2481
2525
|
"name": "getSearchJobsByIdResultsPreview",
|
|
2482
2526
|
"summary": "getSearchJobsByIdResultsPreview",
|
|
@@ -2541,6 +2585,50 @@
|
|
|
2541
2585
|
},
|
|
2542
2586
|
"task": true
|
|
2543
2587
|
},
|
|
2588
|
+
{
|
|
2589
|
+
"name": "getSearchJobsByIdResultsPreviewWithOptions",
|
|
2590
|
+
"summary": "getSearchJobsByIdResultsPreviewWithOptions",
|
|
2591
|
+
"description": "getSearchJobsByIdResultsPreviewWithOptions",
|
|
2592
|
+
"input": [
|
|
2593
|
+
{
|
|
2594
|
+
"name": "searchId",
|
|
2595
|
+
"type": "string",
|
|
2596
|
+
"info": "search_id: string",
|
|
2597
|
+
"required": true,
|
|
2598
|
+
"schema": {
|
|
2599
|
+
"title": "searchId",
|
|
2600
|
+
"type": "string"
|
|
2601
|
+
}
|
|
2602
|
+
},
|
|
2603
|
+
{
|
|
2604
|
+
"name": "queryData",
|
|
2605
|
+
"type": "object",
|
|
2606
|
+
"info": "query options object (e.g. addSummaryToMetadata, count, f, offset, outputMode)",
|
|
2607
|
+
"required": false,
|
|
2608
|
+
"schema": {
|
|
2609
|
+
"title": "queryData",
|
|
2610
|
+
"type": "object"
|
|
2611
|
+
}
|
|
2612
|
+
}
|
|
2613
|
+
],
|
|
2614
|
+
"output": {
|
|
2615
|
+
"name": "result",
|
|
2616
|
+
"type": "object",
|
|
2617
|
+
"description": "A JSON Object containing status, code and the result",
|
|
2618
|
+
"schema": {
|
|
2619
|
+
"title": "result",
|
|
2620
|
+
"type": "object"
|
|
2621
|
+
}
|
|
2622
|
+
},
|
|
2623
|
+
"roles": [
|
|
2624
|
+
"admin"
|
|
2625
|
+
],
|
|
2626
|
+
"route": {
|
|
2627
|
+
"verb": "POST",
|
|
2628
|
+
"path": "/getSearchJobsByIdResultsPreviewWithOptions"
|
|
2629
|
+
},
|
|
2630
|
+
"task": true
|
|
2631
|
+
},
|
|
2544
2632
|
{
|
|
2545
2633
|
"name": "getSearchJobsSearchLogs",
|
|
2546
2634
|
"summary": "getSearchJobsSearchLogs",
|
|
Binary file
|
package/report/adapterInfo.json
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
{
|
|
2
|
-
"version": "0.
|
|
3
|
-
"configLines":
|
|
2
|
+
"version": "0.4.1",
|
|
3
|
+
"configLines": 5097,
|
|
4
4
|
"scriptLines": 1783,
|
|
5
|
-
"codeLines":
|
|
6
|
-
"testLines":
|
|
7
|
-
"testCases":
|
|
8
|
-
"totalCodeLines":
|
|
9
|
-
"wfTasks":
|
|
5
|
+
"codeLines": 6240,
|
|
6
|
+
"testLines": 6537,
|
|
7
|
+
"testCases": 331,
|
|
8
|
+
"totalCodeLines": 14560,
|
|
9
|
+
"wfTasks": 70
|
|
10
10
|
}
|
|
@@ -316,7 +316,7 @@ describe('[unit] Splunk Adapter Test', () => {
|
|
|
316
316
|
assert.notEqual(null, packageDotJson.dependencies);
|
|
317
317
|
assert.notEqual('', packageDotJson.dependencies);
|
|
318
318
|
assert.equal('^8.12.0', packageDotJson.dependencies.ajv);
|
|
319
|
-
assert.equal('^1.
|
|
319
|
+
assert.equal('^1.6.2', packageDotJson.dependencies.axios);
|
|
320
320
|
assert.equal('^11.0.0', packageDotJson.dependencies.commander);
|
|
321
321
|
assert.equal('^11.1.1', packageDotJson.dependencies['fs-extra']);
|
|
322
322
|
assert.equal('^10.2.0', packageDotJson.dependencies.mocha);
|
|
@@ -2995,58 +2995,7 @@ describe('[unit] Splunk Adapter Test', () => {
|
|
|
2995
2995
|
a.getSearchJobsByIdResults(null, null, null, null, (data, error) => {
|
|
2996
2996
|
try {
|
|
2997
2997
|
const displayE = 'searchId is required';
|
|
2998
|
-
runErrorAsserts(data, error, 'AD.300', 'Test-splunk-adapter-
|
|
2999
|
-
done();
|
|
3000
|
-
} catch (err) {
|
|
3001
|
-
log.error(`Test Failure: ${err}`);
|
|
3002
|
-
done(err);
|
|
3003
|
-
}
|
|
3004
|
-
});
|
|
3005
|
-
} catch (error) {
|
|
3006
|
-
log.error(`Adapter Exception: ${error}`);
|
|
3007
|
-
done(error);
|
|
3008
|
-
}
|
|
3009
|
-
}).timeout(attemptTimeout);
|
|
3010
|
-
it('should error if - missing count', (done) => {
|
|
3011
|
-
try {
|
|
3012
|
-
a.getSearchJobsByIdResults('fakeparam', null, null, null, (data, error) => {
|
|
3013
|
-
try {
|
|
3014
|
-
const displayE = 'count is required';
|
|
3015
|
-
runErrorAsserts(data, error, 'AD.300', 'Test-splunk-adapter-getSearchJobsByIdResults', displayE);
|
|
3016
|
-
done();
|
|
3017
|
-
} catch (err) {
|
|
3018
|
-
log.error(`Test Failure: ${err}`);
|
|
3019
|
-
done(err);
|
|
3020
|
-
}
|
|
3021
|
-
});
|
|
3022
|
-
} catch (error) {
|
|
3023
|
-
log.error(`Adapter Exception: ${error}`);
|
|
3024
|
-
done(error);
|
|
3025
|
-
}
|
|
3026
|
-
}).timeout(attemptTimeout);
|
|
3027
|
-
it('should error if - missing addSummaryToMetadata', (done) => {
|
|
3028
|
-
try {
|
|
3029
|
-
a.getSearchJobsByIdResults('fakeparam', 'fakeparam', null, null, (data, error) => {
|
|
3030
|
-
try {
|
|
3031
|
-
const displayE = 'addSummaryToMetadata is required';
|
|
3032
|
-
runErrorAsserts(data, error, 'AD.300', 'Test-splunk-adapter-getSearchJobsByIdResults', displayE);
|
|
3033
|
-
done();
|
|
3034
|
-
} catch (err) {
|
|
3035
|
-
log.error(`Test Failure: ${err}`);
|
|
3036
|
-
done(err);
|
|
3037
|
-
}
|
|
3038
|
-
});
|
|
3039
|
-
} catch (error) {
|
|
3040
|
-
log.error(`Adapter Exception: ${error}`);
|
|
3041
|
-
done(error);
|
|
3042
|
-
}
|
|
3043
|
-
}).timeout(attemptTimeout);
|
|
3044
|
-
it('should error if - missing search', (done) => {
|
|
3045
|
-
try {
|
|
3046
|
-
a.getSearchJobsByIdResults('fakeparam', 'fakeparam', 'fakeparam', null, (data, error) => {
|
|
3047
|
-
try {
|
|
3048
|
-
const displayE = 'search is required';
|
|
3049
|
-
runErrorAsserts(data, error, 'AD.300', 'Test-splunk-adapter-getSearchJobsByIdResults', displayE);
|
|
2998
|
+
runErrorAsserts(data, error, 'AD.300', 'Test-splunk-adapter-getSearchJobsByIdResultsWithOptions', displayE);
|
|
3050
2999
|
done();
|
|
3051
3000
|
} catch (err) {
|
|
3052
3001
|
log.error(`Test Failure: ${err}`);
|
|
@@ -3075,58 +3024,7 @@ describe('[unit] Splunk Adapter Test', () => {
|
|
|
3075
3024
|
a.getSearchJobsByIdResultsPreview(null, null, null, null, (data, error) => {
|
|
3076
3025
|
try {
|
|
3077
3026
|
const displayE = 'searchId is required';
|
|
3078
|
-
runErrorAsserts(data, error, 'AD.300', 'Test-splunk-adapter-
|
|
3079
|
-
done();
|
|
3080
|
-
} catch (err) {
|
|
3081
|
-
log.error(`Test Failure: ${err}`);
|
|
3082
|
-
done(err);
|
|
3083
|
-
}
|
|
3084
|
-
});
|
|
3085
|
-
} catch (error) {
|
|
3086
|
-
log.error(`Adapter Exception: ${error}`);
|
|
3087
|
-
done(error);
|
|
3088
|
-
}
|
|
3089
|
-
}).timeout(attemptTimeout);
|
|
3090
|
-
it('should error if - missing count', (done) => {
|
|
3091
|
-
try {
|
|
3092
|
-
a.getSearchJobsByIdResultsPreview('fakeparam', null, null, null, (data, error) => {
|
|
3093
|
-
try {
|
|
3094
|
-
const displayE = 'count is required';
|
|
3095
|
-
runErrorAsserts(data, error, 'AD.300', 'Test-splunk-adapter-getSearchJobsByIdResultsPreview', displayE);
|
|
3096
|
-
done();
|
|
3097
|
-
} catch (err) {
|
|
3098
|
-
log.error(`Test Failure: ${err}`);
|
|
3099
|
-
done(err);
|
|
3100
|
-
}
|
|
3101
|
-
});
|
|
3102
|
-
} catch (error) {
|
|
3103
|
-
log.error(`Adapter Exception: ${error}`);
|
|
3104
|
-
done(error);
|
|
3105
|
-
}
|
|
3106
|
-
}).timeout(attemptTimeout);
|
|
3107
|
-
it('should error if - missing addSummaryToMetadata', (done) => {
|
|
3108
|
-
try {
|
|
3109
|
-
a.getSearchJobsByIdResultsPreview('fakeparam', 'fakeparam', null, null, (data, error) => {
|
|
3110
|
-
try {
|
|
3111
|
-
const displayE = 'addSummaryToMetadata is required';
|
|
3112
|
-
runErrorAsserts(data, error, 'AD.300', 'Test-splunk-adapter-getSearchJobsByIdResultsPreview', displayE);
|
|
3113
|
-
done();
|
|
3114
|
-
} catch (err) {
|
|
3115
|
-
log.error(`Test Failure: ${err}`);
|
|
3116
|
-
done(err);
|
|
3117
|
-
}
|
|
3118
|
-
});
|
|
3119
|
-
} catch (error) {
|
|
3120
|
-
log.error(`Adapter Exception: ${error}`);
|
|
3121
|
-
done(error);
|
|
3122
|
-
}
|
|
3123
|
-
}).timeout(attemptTimeout);
|
|
3124
|
-
it('should error if - missing search', (done) => {
|
|
3125
|
-
try {
|
|
3126
|
-
a.getSearchJobsByIdResultsPreview('fakeparam', 'fakeparam', 'fakeparam', null, (data, error) => {
|
|
3127
|
-
try {
|
|
3128
|
-
const displayE = 'search is required';
|
|
3129
|
-
runErrorAsserts(data, error, 'AD.300', 'Test-splunk-adapter-getSearchJobsByIdResultsPreview', displayE);
|
|
3027
|
+
runErrorAsserts(data, error, 'AD.300', 'Test-splunk-adapter-getSearchJobsByIdResultsPreviewWithOptions', displayE);
|
|
3130
3028
|
done();
|
|
3131
3029
|
} catch (err) {
|
|
3132
3030
|
log.error(`Test Failure: ${err}`);
|