From fd6e64882f29c984579cb730702fa18aebafaf68 Mon Sep 17 00:00:00 2001 From: pierwill <19642016+pierwill@users.noreply.github.com> Date: Wed, 30 Oct 2019 08:51:25 -0700 Subject: [PATCH] Add semantic newlines to glossary.md --- content/v2.0/reference/glossary.md | 226 ++++++++++++++++++++--------- 1 file changed, 160 insertions(+), 66 deletions(-) diff --git a/content/v2.0/reference/glossary.md b/content/v2.0/reference/glossary.md index 72cb341c2..1e44214d0 100644 --- a/content/v2.0/reference/glossary.md +++ b/content/v2.0/reference/glossary.md @@ -38,7 +38,8 @@ Related entries: [function](#function), [selector](#selector), [transformation]( ### bar graph -A visual representation in the InfluxDB user interface used to compare variables (bars) and plot categorical data. A bar graph has spaces between bars, can be sorted in any order, and bars in the graph typically have the same width. +A visual representation in the InfluxDB user interface used to compare variables (bars) and plot categorical data. +A bar graph has spaces between bars, can be sorted in any order, and bars in the graph typically have the same width. Related entries: [histogram](#histogram) @@ -46,24 +47,28 @@ Related entries: [histogram](#histogram) A collection of points in line protocol format, separated by newlines (`0x0A`). Submitting a batch of points using a single HTTP request to the write endpoints drastically increases performance by reducing the HTTP overhead. -InfluxData typically recommends batch sizes of 5,000-10,000 points. In some use cases, performance may improve with significantly smaller or larger batches. +InfluxData typically recommends batch sizes of 5,000-10,000 points. +In some use cases, performance may improve with significantly smaller or larger batches. Related entries: [line protocol](/v2.0/reference/line-protocol/), [point](#point) ### batch size -The number of lines or individual data points in a line protocol batch. The Telegraf agent sends metrics to output plugins in batches rather than individually. +The number of lines or individual data points in a line protocol batch. +The Telegraf agent sends metrics to output plugins in batches rather than individually. Batch size controls the size of each write batch that Telegraf sends to the output plugins. Related entries: [output plugin](#output-plugin) ### bin -In a cumulative histogram, a bin includes all data points less than or equal to a specified upper bound. In a normal histogram, a bin includes all data points between the upper and lower bounds. +In a cumulative histogram, a bin includes all data points less than or equal to a specified upper bound. +In a normal histogram, a bin includes all data points between the upper and lower bounds. ### block -In Flux, a block is a possibly empty sequence of statements within matching braces (`{ }`). Two types of blocks exist in Flux: +In Flux, a block is a possibly empty sequence of statements within matching braces (`{ }`). +Two types of blocks exist in Flux: - Explicit blocks in the source code, for example: @@ -88,13 +93,16 @@ By convention, you can express `true` as the integer `1` and false as the intege ### bucket -A bucket is a named location where time series data is stored. All buckets have a retention policy, a duration of time that each data point persists. A bucket belongs to an organization. +A bucket is a named location where time series data is stored. +All buckets have a retention policy, a duration of time that each data point persists. +A bucket belongs to an organization. ## C ### check -Checks are part of queries used in monitoring to read input data and assign a [status](#check-status) (`_level`) based on specified conditions. For example: +Checks are part of queries used in monitoring to read input data and assign a [status](#check-status) (`_level`) based on specified conditions. +For example: ``` monitor.check( @@ -121,9 +129,14 @@ Related entries: [check](#check), [notification rule](#notification-rule), [noti ### CSV -Comma-separated values (CSV) delimits text between commas to separate values. A CSV file stores tabular data (numbers and text) in plain text. Each line of the file is a data record. Each record consists of one or more fields, separated by commas. CSV file format is not fully standardized. +Comma-separated values (CSV) delimits text between commas to separate values. +A CSV file stores tabular data (numbers and text) in plain text. +Each line of the file is a data record. +Each record consists of one or more fields, separated by commas. +CSV file format is not fully standardized. -InfluxData uses annotated CSV (comma-separated values) format to encode HTTP responses and results returned to the Flux csv.from() function. For more detail, see [Annotated CSV](/v2.0/reference/annotated-csv/). +InfluxData uses annotated CSV (comma-separated values) format to encode HTTP responses and results returned to the Flux csv.from() function. +For more detail, see [Annotated CSV](/v2.0/reference/annotated-csv/). @@ -312,7 +337,8 @@ Related entries: [block](#block) ### float -A float represents real numbers and is written with a decimal point dividing the integer and fractional parts. For example, 1.0, 3.14. +A float represents real numbers and is written with a decimal point dividing the integer and fractional parts. +For example, 1.0, 3.14. ### flush interval @@ -335,19 +361,23 @@ A lightweight scripting language for querying databases (like InfluxDB) and work ### function -Flux functions aggregate, select, and transform time series data. For a complete list of Flux functions, see [Flux functions](/v2.0/reference/flux/stdlib/all-functions/). +Flux functions aggregate, select, and transform time series data. +For a complete list of Flux functions, see [Flux functions](/v2.0/reference/flux/stdlib/all-functions/). Related entries: [aggregate](#aggregate), [selector](#selector), [transformation](#transformation) ### function block -In Flux, each file has a file block containing all Flux source text in that file. Each function literal has its own function block even if not explicitly declared. +In Flux, each file has a file block containing all Flux source text in that file. +Each function literal has its own function block even if not explicitly declared. ## G ### gauge - A type of visualization that displays the single most recent value for a time series. A gauge typically displays one or more measures from a single row, and is not designed to display multiple rows of data. Elements include a range, major and minor tick marks (within the range), and a pointer (needle) indicating the single most recent value. + A type of visualization that displays the single most recent value for a time series. +A gauge typically displays one or more measures from a single row, and is not designed to display multiple rows of data. +Elements include a range, major and minor tick marks (within the range), and a pointer (needle) indicating the single most recent value. ### graph @@ -408,7 +438,8 @@ The InfluxDB daemon that runs the InfluxDB server and other required processes. ### InfluxDB -An open-source time series database (TSDB) developed by InfluxData. Written in Go and optimized for fast, high-availability storage and retrieval of time series data in fields such as operations monitoring, application metrics, Internet of Things sensor data, and real-time analytics. +An open-source time series database (TSDB) developed by InfluxData. +Written in Go and optimized for fast, high-availability storage and retrieval of time series data in fields such as operations monitoring, application metrics, Internet of Things sensor data, and real-time analytics. ### InfluxDB UI @@ -427,7 +458,8 @@ Related entries: [aggregator plugin](#aggregator-plugin), [collection interval]( ### instance -An entity comprising data on a server (or virtual server in cloud computing). +An entity comprising data on a server (or virtual server in cloud computing). + ### int (data type) @@ -437,7 +469,11 @@ A data type that represents an integer, a whole number that's positive, negative ### JWT -Typically, JSON web tokens (JWT) are used to authenticate users between an identity provider and a service provider. A server can generate a JWT to assert any business processes. For example, an "admin" token sent to a client can prove the client is logged in as admin. Tokens are signed by one party's private key (typically, the server). Private keys are used by both parties to verify that a token is legitimate. +Typically, JSON web tokens (JWT) are used to authenticate users between an identity provider and a service provider. +A server can generate a JWT to assert any business processes. +For example, an "admin" token sent to a client can prove the client is logged in as admin. +Tokens are signed by one party's private key (typically, the server). +Private keys are used by both parties to verify that a token is legitimate. JWT uses an open standard [RFC 7519](https://tools.ietf.org/html/rfc7519). @@ -453,7 +489,8 @@ JavaScript Object Notation (JSON) is an open-standard file format that uses huma ### keyword -A keyword is reserved by a program because it has special meaning. Every programming language has a set of keywords (reserved names) that cannot be used as an identifier. +A keyword is reserved by a program because it has special meaning. +Every programming language has a set of keywords (reserved names) that cannot be used as an identifier. See a list of [Flux keywords](/v2.0/reference/flux/language/lexical-elements/#keywords). @@ -461,7 +498,8 @@ See a list of [Flux keywords](/v2.0/reference/flux/language/lexical-elements/#ke ### literal -A literal is value in an expression, a number, character, string, function, object, or array. Literal values are interpreted as defined. +A literal is value in an expression, a number, character, string, function, object, or array. +Literal values are interpreted as defined. See examples of [Flux literals](/v2.0/reference/flux/language/expressions/#examples-of-function-literals). @@ -474,13 +512,16 @@ Improves workload distribution across multiple computing resources in a network. ### logs -Logs record information. Event logs describe system events and activity that help to describe and diagnose problems. Transaction logs describe changes to stored data that help recover data if a database crashes or other errors occur. +Logs record information. +Event logs describe system events and activity that help to describe and diagnose problems. +Transaction logs describe changes to stored data that help recover data if a database crashes or other errors occur. The InfluxDB 2.0 user interface (UI) can be used to view log history and data. ### Line protocol (LP) -The text based format for writing points to InfluxDB. See [line protocol](/v2.0/reference/line-protocol/). +The text based format for writing points to InfluxDB. +See [line protocol](/v2.0/reference/line-protocol/). ## M @@ -493,7 +534,8 @@ Related entries: [field](#field), [series](#series) ### member -A user in an organization. +A user in an organization. + [series](#series), [tag key](#tag-key), [tag value](#tag-value) ### scrape -InfluxDB scrapes data from specified targets at regular intervals and writes the data to an InfluxDB bucket. Data can be scraped from any accessible endpoint that provides data in the [Prometheus exposition format](https://prometheus.io/docs/instrumenting/exposition_formats/). +InfluxDB scrapes data from specified targets at regular intervals and writes the data to an InfluxDB bucket. +Data can be scraped from any accessible endpoint that provides data in the [Prometheus exposition format](https://prometheus.io/docs/instrumenting/exposition_formats/). ### selector @@ -741,7 +805,8 @@ different `status`es, the series cardinality for the measurement is 6 | cliff@influxdata.com | start | | cliff@influxdata.com | finish | -In some cases, performing this multiplication may overestimate series cardinality because of the presence of dependent tags. Dependent tags are scoped by another tag and do not increase series +In some cases, performing this multiplication may overestimate series cardinality because of the presence of dependent tags. +Dependent tags are scoped by another tag and do not increase series cardinality. If we add the tag `firstname` to the example above, the series cardinality would not be 18 (3 * 2 * 3 = 18). @@ -775,7 +840,8 @@ Related entries: [series](/influxdb/v1.7/concepts/glossary/#series) ### server -A computer, virtual or physical, running InfluxDB. +A computer, virtual or physical, running InfluxDB. + Related entries: [node](#node) @@ -824,7 +890,8 @@ A visualization that displays the numeric value of the most recent point in a ta ### Snappy compression -InfluxDB uses snappy compression to compress batches of points. To improve space and disk IO efficiency, each batch is compressed before being written to disk. +InfluxDB uses snappy compression to compress batches of points. +To improve space and disk IO efficiency, each batch is compressed before being written to disk.