pull/1713/head
noramullen1 2020-10-22 09:55:29 -07:00
commit 69aa1154bb
3 changed files with 46 additions and 26 deletions

View File

@ -146,6 +146,12 @@ Use this endpoint to check the health of your InfluxDB instance.
curl -XGET "localhost:8086/health" curl -XGET "localhost:8086/health"
``` ```
##### /health endpoint responses
| Response code | Health | Message | Status |
|:------------- |:------ |:------- | ------:|
| 200 | Healthy | `ready for queries and writes` | `pass` |
| 503 | Unhealthy | | `fail` |
--- ---
## InfluxDB 1.x HTTP endpoints ## InfluxDB 1.x HTTP endpoints

View File

@ -20,7 +20,7 @@ menu:
| Setters | Description | | Setters | Description |
|:---|:---| |:---|:---|
| **[idle](#idle) ( `value` `time.Duration`)** | Emit barrier based on idle time since the last received message. Must be greater than zero. | | **[idle](#idle) ( `value` `time.Duration`)** | Emit barrier based on idle time since the last received message. Must be greater than zero **and longer than the window `period`**. |
| **[period](#period) ( `value` `time.Duration`)** | Emit barrier based on periodic timer. The timer is based on system clock rather than message time. Must be greater than zero. | | **[period](#period) ( `value` `time.Duration`)** | Emit barrier based on periodic timer. The timer is based on system clock rather than message time. Must be greater than zero. |
@ -40,15 +40,16 @@ emitted barrier will be dropped.
Example: Example:
```javascript ```js
stream stream
|barrier().idle(5s) |barrier()
|window() .idle(11s) // Must be longer than the window period
.period(10s) |window()
.every(5s) .period(10s)
|top(10, 'value') .every(5s)
//Post the top 10 results over the last 10s updated every 5s. |top(10, 'value')
|httpPost('http://example.com/api/top10') //Post the top 10 results over the last 10s updated every 5s.
|httpPost('http://example.com/api/top10')
``` ```
@ -66,13 +67,19 @@ Property methods are marked using the `.` operator.
### Idle ### Idle
Emit barrier based on idle time since the last received message. Emit barrier based on idle time since the last received message.
Must be greater than zero. Must be greater than zero **and longer than the associated window `period`**.
```javascript ```javascript
barrier.idle(value time.Duration) barrier.idle(value time.Duration)
``` ```
{{% warn %}}
#### Barrier idle time and window period
`idle` must be greater than `period` of the associated [window](/kapacitor/v1.4/nodes/window_node/).
If `idle` times are less than the window `period`, data may be lost.
{{% /warn %}}
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a> <a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>

View File

@ -26,33 +26,34 @@ stream
|from() |from()
.measurement('cpu') .measurement('cpu')
|barrier() |barrier()
.idle(5s) .idle(11s) // Must be longer than the window period
.delete(TRUE) .delete(TRUE)
|window() |window()
.period(10s) .period(10s)
.every(5s) .every(5s)
|top(10, 'value') |top(10, 'value')
//Post the top 10 results over the last 10s updated every 5s. // Post the top 10 results over the last 10s updated every 5s.
|httpPost('http://example.com/api/top10') |httpPost('http://example.com/api/top10')
``` ```
> **Note:** In .delete(TRUE), TRUE must be uppercase.
{{% note %}}
In `.delete(TRUE)`, `TRUE` must be uppercase.
{{% /note %}}
### Constructor ### Constructor
| Chaining Method | Description | | Chaining Method | Description |
|:---------|:---------| |:--------- |:--------- |
| **barrier&nbsp;(&nbsp;)** | Create a new Barrier node that emits a BarrierMessage periodically | | **barrier( )** | Create a new Barrier node that emits a BarrierMessage periodically |
### Property Methods ### Property Methods
| Setters | Description | | Setters | Description |
|:---|:---| |:--- |:--- |
| **[idle](#idle)&nbsp;(&nbsp;`value`&nbsp;`time.Duration`)** | Emit barrier based on idle time since the last received message. Must be greater than zero. | | **[idle](#idle)&nbsp;(&nbsp;`value`&nbsp;`time.Duration`)** | Emit barrier based on idle time since the last received message. Must be greater than zero **and longer than the window `period`**. |
| **[period](#period)&nbsp;(&nbsp;`value`&nbsp;`time.Duration`)** | Emit barrier based on periodic timer. The timer is based on system clock rather than message time. Must be greater than zero. | | **[period](#period)&nbsp;(&nbsp;`value`&nbsp;`time.Duration`)** | Emit barrier based on periodic timer. The timer is based on system clock rather than message time. Must be greater than zero. |
| **[delete](#delete)&nbsp;(&nbsp;`value`&nbsp;`Boolean`)** | Delete the group after processing each barrier. | | **[delete](#delete)&nbsp;(&nbsp;`value`&nbsp;`Boolean`)** | Delete the group after processing each barrier. |
| **[quiet](#quiet)&nbsp;(&nbsp;)** | Suppress all error logging events from this node. | | **[quiet](#quiet)&nbsp;(&nbsp;)** | Suppress all error logging events from this node. |
### Chaining Methods ### Chaining Methods
[Alert](#alert), [Alert](#alert),
@ -118,13 +119,19 @@ Property methods are marked using the `.` operator.
### Idle ### Idle
Emit barrier based on idle time since the last received message. Emit barrier based on idle time since the last received message.
Must be greater than zero. Must be greater than zero **and longer than the window `period`**.
```js ```js
barrier.idle(value time.Duration) barrier.idle(value time.Duration)
``` ```
{{% warn %}}
#### Barrier idle time and window period
`idle` must be greater than `period` of the associated [window](/kapacitor/v1.5/nodes/window_node/).
If `idle` times are less than the window `period`, data may be lost.
{{% /warn %}}
<a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a> <a class="top" href="javascript:document.getElementsByClassName('article-heading')[0].scrollIntoView();" title="top"><span class="icon arrow-up"></span></a>