You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Update universal-connector-source.md
Rephrase the text for variables to make it more user friendly.
* Update universal-connector-source.md
Fix references
* Updates from review
* Update universal-connector-source.md
* Fix broken links
---------
Co-authored-by: John Pipkin <[email protected]>
Copy file name to clipboardExpand all lines: docs/send-data/hosted-collectors/cloud-to-cloud-integration-framework/universal-connector-source.md
+23-23Lines changed: 23 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -125,7 +125,7 @@ Invalid examples:
125
125
126
126
#### Request Headers
127
127
128
-
Include any HTTP request headers required by the vendor API. The key names are static text, but the values can access our [template feature](#template-dynamic-values) to make them dynamic.
128
+
Include any HTTP request headers required by the vendor API. The key names are static text, but the values can access our [variables feature](#dynamic-values-variables) to make them dynamic.
@@ -135,7 +135,7 @@ Include any HTTP request headers required by the vendor API. The key names are s
135
135
136
136
#### Request Parameters
137
137
138
-
Include any URL query parameters required by the vendor API. The key names are static text, but the values can access our [template feature](#template-dynamic-values) to make them dynamic.
138
+
Include any URL query parameters required by the vendor API. The key names are static text, but the values can access our [variables feature](#dynamic-values-variables) to make them dynamic.
This is optional and only used if the HTTP `POST` method is configured above. You can use this field to include any information in the HTTP request body. The data included in this field can access our [template feature](#template-dynamic-values).
151
+
This is optional and only used if the HTTP `POST` method is configured above. You can use this field to include any information in the HTTP request body. The data included in this field can access our [dynamic values](#dynamic-values-variables).
152
152
153
153
</div>
154
154
</details>
@@ -159,9 +159,9 @@ This is optional and only used if the HTTP `POST` method is configured above. Yo
159
159
160
160
#### Time Window
161
161
162
-
The source will provide both a start and end timestamp for you to [dynamically](#template-dynamic-values) use in your HTTP request. The window will only move forward if no errors are raised when collecting logs from the vendor API for the current window.
162
+
The source will provide both a start and end timestamp for you to [dynamically](#dynamic-values-variables) use in your HTTP request. The window will only move forward if no errors are raised when collecting logs from the vendor API for the current window.
163
163
164
-
Use the [template feature](#template-dynamic-values) to include the window start and end timestamps within your HTTP request.
164
+
Use the [dynamic values](#dynamic-values-variables) to include the window start and end timestamps within your HTTP request.
165
165
166
166
The start time is inclusive and the end time is exclusive as that is the behavior of most APIs.
167
167
@@ -176,7 +176,7 @@ The start time is inclusive and the end time is exclusive as that is the behavio
Select the format of the data returned by the vendor and configure how the source should break down the response into into individual logs with the correct timestamp.
179
+
Select the format of the data returned by the vendor and configure how the source should break down the response into individual logs with the correct timestamp.
180
180
181
181
#### JSON with JPath
182
182
@@ -330,7 +330,7 @@ Sources can be configured using UTF-8 encoded JSON files with the Collector Ma
330
330
| sourceType | String |`"Universal Connector"`| Yes | Type of source. |
331
331
| config | JSON Object |[Configuration object](#configuration-object)| Yes | Source type specific values. |
332
332
333
-
### Configuration Object
333
+
### Configuration object
334
334
335
335
| Parameter | Type | Required | Default | Description | Example |
@@ -377,17 +377,17 @@ Sources can be configured using UTF-8 encoded JSON files with the Collector Ma
377
377
| clientRateLimitBurst | Integer | Yes |`1000`| The number of requests the source is allowed to burst. |`1000`|
378
378
| pollingInterval | String | Yes |`"5m"`| Set how frequently to poll for new data. It must be between 5 minutes and 48 hours. |`"5m"`|
379
379
380
-
## Template Dynamic Values
380
+
## Dynamic values variables
381
381
382
-
The source has the ability to template in dynamic text into the values of certain fields providing flexibility in crafting the HTTP requests sent to the vendor API.
382
+
The source has the ability to use dynamic values, like the window start time, in the values of certain fields providing flexibility in crafting the HTTP requests sent to the vendor API.
383
383
384
384
The following fields values are allowed to access dynamic text from the template functions described in this section:
385
385
386
386
- HTTP Request Header Values
387
387
- HTTP Request Parameter Values
388
388
- HTTP Request Body
389
389
390
-
To start using the template with one of the supported config values listed above, you will need to enclose the template logic inside double curly braces `{{}}`. Any text outside these double curly braces will be treated as normal unmodified text.
390
+
To start using the variables with one of the supported config values listed above, you will need to enclose the template logic inside double curly braces `{{}}`. Any text outside these double curly braces will be treated as normal unmodified text.
391
391
392
392
Here are some syntax examples calling functions with and without arguments:
393
393
@@ -397,7 +397,7 @@ Here are some syntax examples calling functions with and without arguments:
@@ -406,9 +406,9 @@ Here are some syntax examples calling functions with and without arguments:
406
406
407
407
### WindowStartUTC
408
408
409
-
This function will template in the `start timestamp` of the source window when source is configured to use the `Time Window` progression. The timestamp will always use `UTC` time and never adjust for a specific timezone.
409
+
This variable will get the value in the `start timestamp` of the source window when the source is configured to use the `Time Window` progression. The timestamp will always use `UTC` time and never adjust for a specific timezone.
410
410
411
-
The syntax for this function requires a timestamp format as a single argument. See the [Timestamp Formatting](#timestamp-formatting) section for more information on how to format the timestamp.
411
+
The syntax for this function requires a timestamp format as a single argument. See the [Timestamp formatting](#timestamp-formatting) section for more information on how to format the timestamp.
412
412
413
413
```sh
414
414
{{ .WindowStartUTC "<timestamp format>" }}
@@ -425,13 +425,13 @@ The syntax for this function requires a timestamp format as a single argument. S
425
425
426
426
### WindowStartLocation
427
427
428
-
This function is the same as [WindowStartUTC](#windowstartutc) except it has an additional argument to specify the timezone location.
428
+
This variable is the same as [WindowStartUTC](#windowstartutc) except it has an additional argument to specify the timezone location.
429
429
430
430
:::sumo[Best Practice]
431
431
We strongly recommend you always use `WindowStartUTC` instead of `WindowStartLocation`. Most vendors support and expect UTC timestamps when using their APIs.
432
432
:::
433
433
434
-
Refer to the [TZ identifier](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) for specifying the time zone in the first argument and refer to the [Timestamp Formatting](#timestamp-formatting) section for more information on how to format the timestamp.
434
+
Refer to the [TZ identifier](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) for specifying the time zone in the first argument and refer to the [Timestamp formatting](#timestamp-formatting) section for more information on how to format the timestamp.
435
435
436
436
```sh
437
437
{{ .WindowStartLocation "<time zone location>""<timestamp format>" }}
@@ -448,9 +448,9 @@ Refer to the [TZ identifier](https://en.wikipedia.org/wiki/List_of_tz_database_t
448
448
449
449
### WindowEndUTC
450
450
451
-
This function will template in the `end timestamp` of the source window when source is configured to use the `Time Window` progression. The timestamp will always use `UTC` time and never adjust for a specific timezone.
451
+
This variable will get the value in the `end timestamp` of the source window when the source is configured to use the `Time Window` progression. The timestamp will always use `UTC` time and never adjust for a specific timezone.
452
452
453
-
The syntax for this function requires a timestamp format as a single argument. Refer to the [Timestamp Formatting](#timestamp-formatting) section for more information on how to format the timestamp.
453
+
The syntax for this variable requires a timestamp format as a single argument. Refer to the [Timestamp formatting](#timestamp-formatting) section for more information on how to format the timestamp.
454
454
455
455
```sh
456
456
{{ .WindowEndUTC "<timestamp format>" }}
@@ -465,17 +465,17 @@ The syntax for this function requires a timestamp format as a single argument. R
This function is the same as [WindowEndUTC](#windowendutc) except it has an additional argument to specify the timezone location.
472
+
This variable is the same as [WindowEndUTC](#windowendutc) except it has an additional argument to specify the timezone location.
473
473
474
474
:::sumo[Best Practice]
475
475
We strongly recommend you always use `WindowEndUTC` instead of `WindowEndLocation`. Most vendors support and expect UTC timestamps when using their APIs.
476
476
:::
477
477
478
-
Refer to the [TZ identifier](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) for specifying the time zone in the first argument and refer to the [Timestamp Formatting](#timestamp-formatting) section for more information on how to format the timestamp.
478
+
Refer to the [TZ identifier](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) for specifying the time zone in the first argument and refer to the [Timestamp formatting](#timestamp-formatting) section for more information on how to format the timestamp.
479
479
480
480
```sh
481
481
{{ .WindowEndLocation "<time zone location>""<timestamp format>" }}
@@ -490,15 +490,15 @@ Refer to the [TZ identifier](https://en.wikipedia.org/wiki/List_of_tz_database_t
The source uses the [Go programming language timestamp formatting](https://go.dev/src/time/format.go) and the Human-readable timestamp formatting. See the table below for references and examples.
496
496
497
497
:::sumo[Best Practice]
498
498
We recommend using [this code snippet](https://goplay.tools/snippet/WTFe5ZLU9PO) as a quick way to locally test timestamp parsing with a format before configuring the source.
499
499
:::
500
500
501
-
### Format Reference
501
+
### Format reference
502
502
503
503
| Date Format | Reference Value | Human Readable Referencce Value |
0 commit comments