Skip to content

Commit

Permalink
Merge branch 'master' into v3/timezone-support
Browse files Browse the repository at this point in the history
  • Loading branch information
sanderson authored Oct 17, 2024
2 parents be6084a + 15ee141 commit 69ac0cf
Show file tree
Hide file tree
Showing 75 changed files with 1,010 additions and 313 deletions.
6 changes: 6 additions & 0 deletions .ci/vale/styles/Google/Ordinal.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,9 @@ level: error
nonword: true
tokens:
- \d+(?:st|nd|rd|th)
- tenth

exceptions:
- 0th
- 50th
- 90th
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ influx3
influxctl
influxd
influxdata.com
iox
(iox|IOx)
keep-url
lat
(locf|LOCF)
Expand Down
77 changes: 77 additions & 0 deletions api-docs/cloud-dedicated/v1-compatibility/swaggerV1Compat.yml
Original file line number Diff line number Diff line change
Expand Up @@ -240,6 +240,83 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/Error'
/ping:
get:
description: |
Reports the InfluxQL bridge querier health and the InfluxDB version of the instance.
The response is a HTTP `204` status code to inform you the querier is available.
For InfluxDB Cloud Dedicated, this endpoint only checks the status of queriers; doesn't check the status of ingesters.
To check the health of ingesters before writing data, send a request to one of the [write endpoints](/influxdb/cloud-dedicated/api/v2/#tag/Write).
This endpoint doesn't require authentication.
operationId: GetPing
responses:
'204':
description: |
Success--the querier is available.
Headers contain InfluxDB version information.
headers:
X-Influxdb-Build:
description: |
The type of InfluxDB build.
schema:
type: string
X-Influxdb-Version:
description: |
The version of InfluxDB.
schema:
type: integer
4xx:
description: |
#### InfluxDB Cloud
- Doesn't return this error.
security:
- {}
servers: []
summary: Get the status of the instance
tags:
- Ping
head:
description: |
Reports the InfluxQL bridge querier health and the InfluxDB version of the instance.
The response is a HTTP `204` status code to inform you the querier is available.
For InfluxDB Cloud Dedicated, this endpoint only checks the status of queriers; doesn't check the status of ingesters.
To check the health of ingesters before writing data, send a request to one of the [write endpoints](/influxdb/cloud-dedicated/api/v2/#tag/Write).
This endpoint doesn't require authentication.
operationId: HeadPing
responses:
'204':
description: |
Success--the querier is available.
Headers contain InfluxDB version information.
headers:
X-Influxdb-Build:
description: The type of InfluxDB build.
schema:
type: string
X-Influxdb-Version:
description: |
The version of InfluxDB.
schema:
type: integer
4xx:
description: |
#### InfluxDB Cloud
- Doesn't return this error.
security:
- {}
servers: []
summary: Get the status of the instance
tags:
- Ping
components:
parameters:
TraceSpan:
Expand Down
22 changes: 14 additions & 8 deletions api-docs/cloud-dedicated/v2/ref.yml
Original file line number Diff line number Diff line change
Expand Up @@ -149,17 +149,20 @@ paths:
/ping:
get:
description: |
Retrieves the status and InfluxDB version of the instance.
Reports the InfluxQL bridge querier health and the InfluxDB version of the instance.
The response is a HTTP `204` status code to inform you the querier is available.
Use this endpoint to monitor uptime for the InfluxDB instance. The response
returns a HTTP `204` status code to inform you the instance is available.
For InfluxDB Cloud Dedicated, this endpoint only checks the status of queriers; doesn't check the status of ingesters.
To check the health of ingesters before writing data, send a request to one of the [write endpoints](/influxdb/cloud-dedicated/api/v2/#tag/Write).
This endpoint doesn't require authentication.
operationId: GetPing
responses:
'204':
description: |
Success.
Success--the querier is available.
Headers contain InfluxDB version information.
headers:
X-Influxdb-Build:
Expand All @@ -184,17 +187,20 @@ paths:
- Ping
head:
description: |
Returns the status and InfluxDB version of the instance.
Reports the InfluxQL bridge querier health and the InfluxDB version of the instance.
The response is a HTTP `204` status code to inform you the querier is available.
For InfluxDB Cloud Dedicated, this endpoint only checks the status of queriers; doesn't check the status of ingesters.
Use this endpoint to monitor uptime for the InfluxDB instance. The response
returns a HTTP `204` status code to inform you the instance is available.
To check the health of ingesters before writing data, send a request to one of the [write endpoints](/influxdb/cloud-dedicated/api/v2/#tag/Write).
This endpoint doesn't require authentication.
operationId: HeadPing
responses:
'204':
description: |
Success.
Success--the querier is available.
Headers contain InfluxDB version information.
headers:
X-Influxdb-Build:
Expand Down
20 changes: 18 additions & 2 deletions api-docs/clustered/v2/ref.yml
Original file line number Diff line number Diff line change
Expand Up @@ -646,17 +646,33 @@ paths:
'204':
description: Write data is correctly formatted and accepted for writing to the database.
'400':
description: |
Data from the batch was rejected and not written. The response body indicates if a partial write occurred or all data was rejected.
If a partial write occurred, then some points from the batch are written and queryable.
The response body contains details about the [rejected points](/influxdb/clustered/write-data/troubleshoot/#troubleshoot-rejected-points), up to 100 points.
content:
application/json:
examples:
rejectedAllPoints:
summary: Rejected all points
value:
code: invalid
line: 2
message: 'no data written, errors encountered on line(s): error message for first rejected point</n> error message for second rejected point</n> error message for Nth rejected point (up to 100 rejected points)'
partialWriteErrorWithRejectedPoints:
summary: Partial write rejects some points
value:
code: invalid
line: 2
message: 'partial write has occurred, errors encountered on line(s): error message for first rejected point</n> error message for second rejected point</n> error message for Nth rejected point (up to 100 rejected points)'
schema:
$ref: '#/components/schemas/LineProtocolError'
description: Line protocol poorly formed and no points were written. Response can be used to determine the first malformed line in the body line-protocol. All data in body was rejected and not written.
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Token doesn't have sufficient permissions to write to this database or the database doesn't exist.
description: Token doesn't have sufficient permissions to write to this database or the database doesn't exist.
'403':
content:
application/json:
Expand Down
3 changes: 2 additions & 1 deletion content/chronograf/v1/administration/managing-security.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
title: Manage Chronograf security
description: Manage Chronograf security with OAuth 2.0 providers.
aliases: /chronograf/v1/administration/security-best-practices/
aliases:
- /chronograf/v1/administration/security-best-practices/
menu:
chronograf_v1:
name: Manage Chronograf security
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ menu:
name: Frequently asked questions (FAQs)
weight: 10
parent: Troubleshoot
aliases:
- /chronograf/latest/guides/transition-web-admin-interface/
---

## How do I connect Chronograf to an InfluxDB Enterprise cluster?
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Monitoring is the act of observing changes in data over time.
There are multiple ways to monitor your InfluxDB Enterprise cluster.
See the guides below to monitor a cluster using another InfluxDB instance.

Alternatively, to view your output data occasionally (_e.g._, for auditing or diagnostics),
Alternatively, to view your output data occasionally (for example, for auditing or diagnostics),
do one of the following:

- [Log and trace InfluxDB Enterprise operations](/enterprise_influxdb/v1/administration/monitor/logs/)
Expand All @@ -22,7 +22,7 @@ do one of the following:
### Monitor with InfluxDB Insights
For InfluxDB Enterprise customers, Insights is a free service that monitors your cluster and sends metrics to a private Cloud account. This allows InfluxDB Support to monitor your cluster health and access usage statistics when assisting with support tickets that you raise.

To apply for this service, please contact the [support team](https://support.influxdata.com/s/login/).
To apply for this service, please [contact InfluxData support](https://support.influxdata.com).
{{% /note %}}

{{< children >}}
Original file line number Diff line number Diff line change
Expand Up @@ -182,4 +182,4 @@ Send a notification to PagerDuty or HTTP endpoints (other webhooks) by [upgradin
For InfluxDB Enterprise customers, Insights is a free service that monitors your cluster and sends metrics to a private Cloud account. This allows InfluxDB Support to monitor your cluster health and access usage statistics when assisting with support tickets that you raise.
To apply for this service, please contact the [InfluxData Support team](mailto:support@influxdata.com).
To apply for this service, please [contact InfluxData support](https://support.influxdata.com).
4 changes: 2 additions & 2 deletions content/enterprise_influxdb/v1/concepts/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -449,8 +449,8 @@ Related entries: [tsm](#tsm-time-structured-merge-tree)

## web console

Legacy user interface for the InfluxDB Enterprise.
Legacy user interface for InfluxDB Enterprise.

This interface has been deprecated. We recommend using [Chronograf](/chronograf/v1/introduction/).

If you are transitioning from the Enterprise Web Console to Chronograf, see how to [transition from the InfluxDB Web Admin Interface](/chronograf/v1/guides/transition-web-admin-interface/).
If you are transitioning from the Enterprise Web Console to Chronograf, see how to [connect Chronograf to an InfluxDB Enterprise cluster](/chronograf/v1/troubleshooting/frequently-asked-questions/#how-do-i-connect-chronograf-to-an-influxdb-enterprise-cluster).
3 changes: 1 addition & 2 deletions content/enterprise_influxdb/v1/guides/query_data.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
---
title: Query data with the InfluxDB API
description: Query data with Flux and InfluxQL in the InfluxDB API.
alias:
-/docs/v1.8/query_language/querying_data/
menu:
enterprise_influxdb_v1:
weight: 20
parent: Guides
aliases:
- /enterprise_influxdb/v1/guides/querying_data/
- /docs/v1.8/query_language/querying_data/
v2: /influxdb/v2/query-data/
---

Expand Down
34 changes: 29 additions & 5 deletions content/flux/v0/stdlib/influxdata/influxdb/cardinality.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: influxdb.cardinality() function
description: >
`influxdb.cardinality()` returns the series cardinality of data stored in InfluxDB.
`influxdb.cardinality()` returns the series cardinality of data retrieved from InfluxDB.
menu:
flux_v0_ref:
name: influxdb.cardinality
Expand All @@ -28,9 +28,16 @@ Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md
------------------------------------------------------------------------------->

`influxdb.cardinality()` returns the series cardinality of data stored in InfluxDB.
`influxdb.cardinality()` returns the series cardinality of data retrieved from InfluxDB.


{{% note %}}
Although this function is similar to InfluxQL's [`SHOW SERIES CARDINALITY`](/influxdb/v1/query_language/spec/#show-series-cardinality),
it works in a slightly different manner.

`influxdb.cardinality()` is time bounded and reports the cardinality of data that matches the conditions passed into it rather than that of the bucket as a whole.
{{% /note %}}


##### Function type signature

Expand Down Expand Up @@ -107,6 +114,12 @@ The cardinality calculation excludes points that match the specified start time.
Use a relative duration or absolute time. For example, `-1h` or `2019-08-28T22:00:00Z`.
Durations are relative to `now()`. Default is `now()`.

{{% note %}}
The default value is `now()`, so any points that have been written into the future will
not be counted unless a future `stop` date is provided.
{{% /note %}}


### predicate

Predicate function that filters records.
Expand All @@ -120,15 +133,17 @@ Default is `(r) => true`.
- [Query series cardinality in a bucket](#query-series-cardinality-in-a-bucket)
- [Query series cardinality in a measurement//](#query-series-cardinality-in-a-measurement)
- [Query series cardinality for a specific tag](#query-series-cardinality-for-a-specific-tag)
- [Query series cardinality of Data Written In the Last 4 Hours](#query-series-cardinality-of-data-written-in-the-last-4-hours)

### Query series cardinality in a bucket

```js
import "influxdata/influxdb"

influxdb.cardinality(bucket: "example-bucket", start: -1y)
influxdb.cardinality(bucket: "example-bucket", start: time(v: 1))

```
Note: if points have been written into the future, you will need to add an appropriate `stop` date


### Query series cardinality in a measurement//
Expand All @@ -138,7 +153,7 @@ import "influxdata/influxdb"

influxdb.cardinality(
bucket: "example-bucket",
start: -1y,
start: time(v: 1),
predicate: (r) => r._measurement == "example-measurement",
)

Expand All @@ -150,7 +165,16 @@ influxdb.cardinality(
```js
import "influxdata/influxdb"

influxdb.cardinality(bucket: "example-bucket", start: -1y, predicate: (r) => r.exampleTag == "foo")
influxdb.cardinality(bucket: "example-bucket", start: time(v: 1), predicate: (r) => r.exampleTag == "foo")

```


### Query Cardinality of Data Written In the Last 4 hours
```js
import "influxdata/influxdb"

influxdb.cardinality(bucket: "example-bucket", start: -4h)

```

Loading

0 comments on commit 69ac0cf

Please sign in to comment.