fixing md lint errors

pull/5992/head
Scott Anderson 2025-04-16 09:11:09 -06:00
parent d49cf61838
commit 3db5c7465d
5 changed files with 117 additions and 95 deletions

View File

@ -326,19 +326,19 @@ features, performance improvements, and bug fixes below.
This release updates support for the Flux language and queries. To learn about Flux design principles and see how to get started with Flux, see [Introduction to Flux](/influxdb/v1/flux/).
* Use the new [`influx -type=flux`](/influxdb/v1/tools/influx-cli/#flags) option to enable the Flux REPL shell for creating Flux queries.
- Use the new [`influx -type=flux`](/influxdb/v1/tools/influx-cli/#flags) option to enable the Flux REPL shell for creating Flux queries.
* Flux v0.65 includes the following capabilities:
- Join data residing in multiple measurements, buckets, or data sources
- Perform mathematical operations using data gathered across measurements/buckets
- Manipulate Strings through an extensive library of string related functions
- Shape data through `pivot()` and other functions
- Group based on any data column: tags, fields, etc.
- Window and aggregate based on calendar months, years
- Join data across Influx and non-Influx sources
- Cast booleans to integers
- Query geo-temporal data (experimental)
- Many additional functions for working with data
- Flux v0.65 includes the following capabilities:
- Join data residing in multiple measurements, buckets, or data sources
- Perform mathematical operations using data gathered across measurements/buckets
- Manipulate Strings through an extensive library of string related functions
- Shape data through `pivot()` and other functions
- Group based on any data column: tags, fields, etc.
- Window and aggregate based on calendar months, years
- Join data across Influx and non-Influx sources
- Cast booleans to integers
- Query geo-temporal data (experimental)
- Many additional functions for working with data
> We're evaluating the need for Flux query management controls equivalent to existing InfluxQL [query management controls](/influxdb/v1/troubleshooting/query_management/#configuration-settings-for-query-management) based on your feedback. Please join the discussion on [InfluxCommunity](https://community.influxdata.com/), [Slack](https://influxcommunity.slack.com/), or [GitHub](https://github.com/influxdata/flux). InfluxDB Enterprise customers, please contact <support@influxdata.com>.

View File

@ -666,7 +666,7 @@ from(bucket: "example-tmp-db/autogen")
For more information, see
[How does InfluxDB handle duplicate points?](/influxdb/v1/troubleshooting/frequently-asked-questions/#how-does-influxdb-handle-duplicate-points)
3. Use InfluxQL to delete the temporary database.
3. Use InfluxQL to delete the temporary database.
```sql
DROP DATABASE "example-tmp-db"

View File

@ -55,40 +55,54 @@ Configuration settings that specify a duration support the following duration un
- `d` _(days)_
- `w` _(weeks)_
>**Note:** Configuration file settings are documented here for the latest official release - the [sample configuration file on GitHub](https://github.com/influxdb/influxdb/blob/1.8/etc/config.sample.toml) might be slightly newer.
> [!Note]
> Configuration file settings are documented here for the latest official release.
> The [sample configuration file on GitHub](https://github.com/influxdb/influxdb/blob/1.8/etc/config.sample.toml)
> might be slightly newer.
## Environment variables
All of the configuration settings in the configuration file can be specified either in the configuration file or in an environment variable.
All of the configuration settings in the configuration file can be specified
either in the configuration file or in an environment variable.
The environment variable overrides the equivalent option in the configuration
file.
If a configuration option is not specified in either the configuration file or in an environment variable, InfluxDB uses its internal default configuration.
file. If a configuration option is not specified in either the configuration
file or in an environment variable, InfluxDB uses its internal default configuration.
> ***Note:*** If an environment variable has already been set, the equivalent configuration setting in the configuration file is ignored.
> [!Note]
> If an environment variable has already been set, the equivalent configuration
> setting in the configuration file is ignored.
### InfluxDB environment variables (`INFLUXDB_*`)
The InfluxDB environment variables are documented below with the corresponding configuration file settings. All of the InfluxDB-specific environment variables are prefixed with `INFLUXDB_`.
The InfluxDB environment variables are documented below with the corresponding
configuration file settings. All of the InfluxDB-specific environment variables
are prefixed with `INFLUXDB_`.
### `GOMAXPROCS` environment variable
> ***Note:*** The GOMAXPROCS environment variable cannot be set using the InfluxDB configuration file settings, like other environment variables.
> [!Note]
> The GOMAXPROCS environment variable cannot be set using the InfluxDB
> configuration file settings, like other environment variables.
The `GOMAXPROCS` [Go language environment variable](https://golang.org/pkg/runtime/#hdr-Environment_Variables)
can be used to set the maximum number of CPUs that can execute simultaneously.
The `GOMAXPROCS` [Go language environment variable](https://golang.org/pkg/runtime/#hdr-Environment_Variables) can be used to set the maximum number of CPUs that can execute simultaneously.
The default value of `GOMAXPROCS` is the number of CPUs (whatever your operating
system considers to be a CPU) that are visible to the program *on startup.*
For a 32-core machine, the `GOMAXPROCS` value would be `32`.
You can override this value to be less than the maximum value, which can be
useful in cases where you are running the InfluxDB along with other processes on
the same machine and want to ensure that the database doesn't completely starve
those processes.
The default value of `GOMAXPROCS` is the number of CPUs (whatever your operating system considers to be a CPU) that are visible to the program *on startup.* For a 32-core machine, the `GOMAXPROCS` value would be `32`.
You can override this value to be less than the maximum value, which can be useful in cases where you are running the InfluxDB along with other processes on the same machine and want to ensure that the database doesn't completely starve those processes.
> ***Note:***
> [!Note]
> Setting `GOMAXPROCS=1` will eliminate all parallelization.
## Using the configuration file
The InfluxDB system has internal defaults for all of the settings in the configuration file. To view the default configuration settings, use the `influxd config` command.
The InfluxDB system has internal defaults for all of the settings in the
configuration file. To view the default configuration settings, use the
`influxd config` command.
The local InfluxDB configuration file is located here:
@ -96,27 +110,30 @@ The local InfluxDB configuration file is located here:
- **macOS**: `/usr/local/etc/influxdb.conf`
- **Windows**: _Same directory as `influxd.exe`_
Settings that are commented out are set to the internal system defaults. Uncommented settings override the internal defaults.
Note that the local configuration file does not need to include every configuration setting.
Settings that are commented out are set to the internal system defaults.
Uncommented settings override the internal defaults.
Note that the local configuration file does not need to include every
configuration setting.
There are two ways to launch InfluxDB with your configuration file:
* Point the process to the configuration file by using the `-config`
- Point the process to the configuration file by using the `-config`
option. For example:
```bash
influxd -config /etc/influxdb/influxdb.conf
```
* Set the environment variable `INFLUXDB_CONFIG_PATH` to the path of your
```bash
influxd -config /etc/influxdb/influxdb.conf
```
- Set the environment variable `INFLUXDB_CONFIG_PATH` to the path of your
configuration file and start the process.
For example:
```
echo $INFLUXDB_CONFIG_PATH
/etc/influxdb/influxdb.conf
```bash
echo $INFLUXDB_CONFIG_PATH
/etc/influxdb/influxdb.conf
influxd
```
influxd
```
InfluxDB first checks for the `-config` option and then for the environment
variable.
@ -124,7 +141,7 @@ variable.
## Configuration settings
> **Note:**
> [!Note]
> To set or override settings in a config section that allows multiple
> configurations (any section with `[[double_brackets]]` in the header supports
> multiple configurations), the desired configuration must be specified by ordinal
@ -133,24 +150,25 @@ variable.
> prefix the configuration setting name in the environment variable with the
> relevant position number (in this case: `0`):
>
INFLUXDB_GRAPHITE_0_BATCH_PENDING
INFLUXDB_GRAPHITE_0_BATCH_SIZE
INFLUXDB_GRAPHITE_0_BATCH_TIMEOUT
INFLUXDB_GRAPHITE_0_BIND_ADDRESS
INFLUXDB_GRAPHITE_0_CONSISTENCY_LEVEL
INFLUXDB_GRAPHITE_0_DATABASE
INFLUXDB_GRAPHITE_0_ENABLED
INFLUXDB_GRAPHITE_0_PROTOCOL
INFLUXDB_GRAPHITE_0_RETENTION_POLICY
INFLUXDB_GRAPHITE_0_SEPARATOR
INFLUXDB_GRAPHITE_0_TAGS
INFLUXDB_GRAPHITE_0_TEMPLATES
INFLUXDB_GRAPHITE_0_UDP_READ_BUFFER
> ```txt
> INFLUXDB_GRAPHITE_0_BATCH_PENDING
> INFLUXDB_GRAPHITE_0_BATCH_SIZE
> INFLUXDB_GRAPHITE_0_BATCH_TIMEOUT
> INFLUXDB_GRAPHITE_0_BIND_ADDRESS
> INFLUXDB_GRAPHITE_0_CONSISTENCY_LEVEL
> INFLUXDB_GRAPHITE_0_DATABASE
> INFLUXDB_GRAPHITE_0_ENABLED
> INFLUXDB_GRAPHITE_0_PROTOCOL
> INFLUXDB_GRAPHITE_0_RETENTION_POLICY
> INFLUXDB_GRAPHITE_0_SEPARATOR
> INFLUXDB_GRAPHITE_0_TAGS
> INFLUXDB_GRAPHITE_0_TEMPLATES
> INFLUXDB_GRAPHITE_0_UDP_READ_BUFFER
> ```
>
>For the Nth Graphite configuration in the configuration file, the relevant
>environment variables would be of the form `INFLUXDB_GRAPHITE_(N-1)_BATCH_PENDING`.
>For each section of the configuration file the numbering restarts at zero.
> For the Nth Graphite configuration in the configuration file, the relevant
> environment variables would be of the form `INFLUXDB_GRAPHITE_(N-1)_BATCH_PENDING`.
> For each section of the configuration file the numbering restarts at zero.
## Global settings

View File

@ -398,11 +398,15 @@ This error occurs when the Docker container cannot read files on the host machin
#### Make host machine files readable to Docker
1. Create a directory, and then copy files to import into InfluxDB to this directory.
2. When you launch the Docker container, mount the new directory on the InfluxDB container by running the following command:
1. Create a directory, and then copy files to import into InfluxDB to this directory.
2. When you launch the Docker container, mount the new directory on the InfluxDB container by running the following command:
docker run -v /dir/path/on/host:/dir/path/in/container
```bash
docker run -v /dir/path/on/host:/dir/path/in/container
```
3. Verify the Docker container can read host machine files by running the following command:
3. Verify the Docker container can read host machine files by running the following command:
influx -import -path=/path/in/container
```bash
influx -import -path=/path/in/container
```

View File

@ -623,9 +623,9 @@ Avoid using the same name for a tag and field key. If you inadvertently add the
#### Example
1. [Launch `influx`](/influxdb/v1/tools/shell/#launch-influx).
1. [Launch `influx`](/influxdb/v1/tools/shell/#launch-influx).
2. Write the following points to create both a field and tag key with the same name `leaves`:
2. Write the following points to create both a field and tag key with the same name `leaves`:
```bash
# create the `leaves` tag key
@ -635,7 +635,7 @@ Avoid using the same name for a tag and field key. If you inadvertently add the
INSERT grape leaves=5
```
3. If you view both keys, you'll notice that neither key includes `_1`:
3. If you view both keys, you'll notice that neither key includes `_1`:
```bash
# show the `leaves` tag key
@ -655,7 +655,7 @@ Avoid using the same name for a tag and field key. If you inadvertently add the
leaves float
```
4. If you query the `grape` measurement, you'll see the `leaves` tag key has an appended `_1`:
4. If you query the `grape` measurement, you'll see the `leaves` tag key has an appended `_1`:
```bash
# query the `grape` measurement
@ -668,7 +668,7 @@ Avoid using the same name for a tag and field key. If you inadvertently add the
1574128238044155000 5.00
```
5. To query a duplicate key name, you **must drop** `_1` **and include** `::tag` or `::field` after the key:
5. To query a duplicate key name, you **must drop** `_1` **and include** `::tag` or `::field` after the key:
```bash
# query duplicate keys using the correct syntax
@ -693,9 +693,9 @@ the allotted memory.
#### Remove a duplicate key
1. [Launch `influx`](/influxdb/v1/tools/shell/#launch-influx).
1. [Launch `influx`](/influxdb/v1/tools/shell/#launch-influx).
2. Use the following queries to remove a duplicate key.
2. Use the following queries to remove a duplicate key.
```sql
@ -1093,39 +1093,39 @@ time az hostname val_1 val_2
To store both points:
* Introduce an arbitrary new tag to enforce uniqueness.
- Introduce an arbitrary new tag to enforce uniqueness.
Old point: `cpu_load,hostname=server02,az=us_west,uniq=1 val_1=24.5,val_2=7 1234567890000000`
Old point: `cpu_load,hostname=server02,az=us_west,uniq=1 val_1=24.5,val_2=7 1234567890000000`
New point: `cpu_load,hostname=server02,az=us_west,uniq=2 val_1=5.24 1234567890000000`
New point: `cpu_load,hostname=server02,az=us_west,uniq=2 val_1=5.24 1234567890000000`
After writing the new point to InfluxDB:
After writing the new point to InfluxDB:
```sql
> SELECT * FROM "cpu_load" WHERE time = 1234567890000000
name: cpu_load
--------------
time az hostname uniq val_1 val_2
1970-01-15T06:56:07.89Z us_west server02 1 24.5 7
1970-01-15T06:56:07.89Z us_west server02 2 5.24
```
```sql
> SELECT * FROM "cpu_load" WHERE time = 1234567890000000
name: cpu_load
--------------
time az hostname uniq val_1 val_2
1970-01-15T06:56:07.89Z us_west server02 1 24.5 7
1970-01-15T06:56:07.89Z us_west server02 2 5.24
```
* Increment the timestamp by a nanosecond.
- Increment the timestamp by a nanosecond.
Old point: `cpu_load,hostname=server02,az=us_west val_1=24.5,val_2=7 1234567890000000`
Old point: `cpu_load,hostname=server02,az=us_west val_1=24.5,val_2=7 1234567890000000`
New point: `cpu_load,hostname=server02,az=us_west val_1=5.24 1234567890000001`
New point: `cpu_load,hostname=server02,az=us_west val_1=5.24 1234567890000001`
After writing the new point to InfluxDB:
After writing the new point to InfluxDB:
```sql
> SELECT * FROM "cpu_load" WHERE time >= 1234567890000000 and time <= 1234567890000001
name: cpu_load
--------------
time az hostname val_1 val_2
1970-01-15T06:56:07.89Z us_west server02 24.5 7
1970-01-15T06:56:07.890000001Z us_west server02 5.24
```
```sql
> SELECT * FROM "cpu_load" WHERE time >= 1234567890000000 and time <= 1234567890000001
name: cpu_load
--------------
time az hostname val_1 val_2
1970-01-15T06:56:07.89Z us_west server02 24.5 7
1970-01-15T06:56:07.890000001Z us_west server02 5.24
```
## What newline character does the InfluxDB API require?