From abe96fc20086063969f0954ca183d91a35090d2b Mon Sep 17 00:00:00 2001 From: Edward Welch Date: Tue, 10 Sep 2019 17:15:08 -0400 Subject: [PATCH] fixing lots of broken links and a few typos --- docs/governance/README.md | 4 ++-- docs/logentry/processing-log-lines.md | 12 ++++++------ docs/loki/api.md | 2 +- docs/loki/operations.md | 6 +++--- docs/loki/storage.md | 6 +++--- docs/promtail.md | 4 ++-- docs/promtail/api.md | 2 +- docs/promtail/config-examples.md | 2 +- docs/promtail/configuration.md | 2 +- docs/promtail/deployment-methods.md | 2 +- 10 files changed, 21 insertions(+), 21 deletions(-) diff --git a/docs/governance/README.md b/docs/governance/README.md index 77b19a7727b3..f34ec1170f84 100644 --- a/docs/governance/README.md +++ b/docs/governance/README.md @@ -58,11 +58,11 @@ Upon death of a member, their team membership ends automatically. ### Technical decisions -Technical decisions are made informally by the team member, and [lazy consensus]((#concensus)) is assumed. If no consensus can be reached, the matter may be resolved by [majority vote](#majority-vote). +Technical decisions are made informally by the team member, and [lazy consensus](#consensus) is assumed. If no consensus can be reached, the matter may be resolved by [majority vote](#majority-vote). ### Governance changes -Material changes to this document are discussed publicly on as an issue on the Loki repo. Any change requires a [supermajority](#supermajority-vote) in favor. Editorial changes may be made by [lazy consensus](#concensus) unless challenged. +Material changes to this document are discussed publicly on as an issue on the Loki repo. Any change requires a [supermajority](#supermajority-vote) in favor. Editorial changes may be made by [lazy consensus](#consensus) unless challenged. ### Other matters diff --git a/docs/logentry/processing-log-lines.md b/docs/logentry/processing-log-lines.md index 5fef9b0540aa..78fc580990aa 100644 --- a/docs/logentry/processing-log-lines.md +++ b/docs/logentry/processing-log-lines.md @@ -93,21 +93,21 @@ The second `match` stage will only run if a label named `app` == `some-app`, it More info on each field in the interface: -##### labels +##### labels model.LabelSet A set of prometheus style labels which will be sent with the log line and will be indexed by Loki. -##### extracted +##### extracted map[string]interface{} metadata extracted during the pipeline execution which can be used by subsequent stages. This data is not sent with the logs and is dropped after the log entry is processed through the pipeline. For example, stages like [regex](#regex) and [json](#json) will use expressions to extract data from a log line and store it in the `extracted` map, which following stages like [timestamp](#timestamp) or [output](#output) can use to manipulate the log lines `time` and `entry`. -##### time +##### time *time.Time -The timestamp which loki will store for the log line, if not set within the pipeline using the [time](#time) stage, it will default to time.Now(). +The timestamp which loki will store for the log line, if not set within the pipeline using the [timestamp](#timestamp) stage, it will default to time.Now(). -##### entry +##### entry *string The log line which will be stored by loki, the [output](#output) stage is capable of modifying this value, if no stage modifies this value the log line stored will match what was input to the system and not be modified. @@ -352,7 +352,7 @@ A match stage will take the provided label `selector` and determine if a group o pipeline_name: loki_pipeline ② stages: ③ ``` -① `selector` is **required** and must be a [logql stream selector](../usage.md#log-stream-selector). +① `selector` is **required** and must be a [logql stream selector](../querying.md#log-stream-selector). ② `pipeline_name` is **optional** but when defined, will create an additional label on the `pipeline_duration_seconds` histogram, the value for `pipeline_name` will be concatenated with the `job_name` using an underscore: `job_name`_`pipeline_name` ③ `stages` is a **required** list of additional pipeline stages which will only be executed if the defined `selector` matches the labels. The format is a list of pipeline stages which is defined exactly the same as the root pipeline diff --git a/docs/loki/api.md b/docs/loki/api.md index 480d7b5757e4..39f4d026438b 100644 --- a/docs/loki/api.md +++ b/docs/loki/api.md @@ -212,7 +212,7 @@ The Loki server has the following API endpoints (_Note:_ Authentication is out o load to the index server and make the query slower. > This endpoint will be deprecated in the future you should use `api/v1/query_range` instead. - > You can only query for logs, it doesn't accept [queries returning metrics](./usage.md#counting-logs). + > You can only query for logs, it doesn't accept [queries returning metrics](../querying.md#counting-logs). Responses looks like this: diff --git a/docs/loki/operations.md b/docs/loki/operations.md index 11938e8ab4e1..0643b7fe3c7a 100644 --- a/docs/loki/operations.md +++ b/docs/loki/operations.md @@ -6,7 +6,7 @@ This page lists operational aspects of running Loki in alphabetical order: Loki does not have an authentication layer. You are expected to run an authenticating reverse proxy in front of your services, such as an Nginx with basic auth or an OAuth2 proxy. -See [client options](./promtail/deployment-methods.md#custom-client-options) for more details about supported authentication methods. +See [client options](../promtail/deployment-methods.md#custom-client-options) for more details about supported authentication methods. ### Multi-tenancy @@ -56,7 +56,7 @@ You can import dashboard with ID [10004](https://grafana.com/dashboards/10004) t ### Monitoring Mixins -Check out our [Loki mixin](../production/loki-mixin) for a set of dashboards, recording rules, and alerts. +Check out our [Loki mixin](../../production/loki-mixin) for a set of dashboards, recording rules, and alerts. These give you a comprehensive package on how to monitor Loki in production. For more information about mixins, take a look at the [mixins project docs](https://github.com/monitoring-mixins/docs). @@ -83,6 +83,6 @@ You will still be able to see related labels, but the log retrieval of the delet See this [blog post](https://grafana.com/blog/2018/12/12/loki-prometheus-inspired-open-source-logging-for-cloud-natives/) on a discussion about Loki's scalability. When scaling Loki, consider running several Loki processes with their respective roles of ingestor, distributor, and querier. -Take a look at their respective `.libsonnet` files in [our production setup](../production/ksonnet/loki) to get an idea about resource usage. +Take a look at their respective `.libsonnet` files in [our production setup](../../production/ksonnet/loki) to get an idea about resource usage. We're happy to get feedback about your resource usage. diff --git a/docs/loki/storage.md b/docs/loki/storage.md index 8bfcc520e77f..8df1c654136a 100644 --- a/docs/loki/storage.md +++ b/docs/loki/storage.md @@ -4,7 +4,7 @@ Loki needs to store two different types of data: **Chunks** and **Indexes**. Loki receives logs in separate streams. Each stream is identified by a set of labels. As the log entries from a stream arrive, they are gzipped as chunks and saved in -the chunks store. The chunk format is documented in [`pkg/chunkenc`](../pkg/chunkenc/README.md). +the chunks store. The chunk format is documented in [`pkg/chunkenc`](../../pkg/chunkenc/README.md). On the other hand, the index stores the stream's label set and links them to the individual chunks. @@ -82,7 +82,7 @@ storage_config: #### S3 Loki can use S3 as object storage, storing logs within directories based on -the [OrgID](./operations.md#Multi-tenancy). For example, logs from the `faker` +the [OrgID](./operations.md#multi-tenancy). For example, logs from the `faker` org will be stored in `s3://BUCKET_NAME/faker/`. The S3 configuration is set up using the URL format: @@ -119,7 +119,7 @@ DynamoDB can be set up manually or automatically through `table-manager`. The `table-manager` allows deleting old indices by rotating a number of different DynamoDB tables and deleting the oldest one. An example deployment of the `table-manager` using ksonnet can be found -[here](../production/ksonnet/loki/table-manager.libsonnet) and more information +[here](../../production/ksonnet/loki/table-manager.libsonnet) and more information about it can be find at the [Cortex project](https://github.com/cortexproject/cortex). diff --git a/docs/promtail.md b/docs/promtail.md index a547ea36d626..2a5ace60a8eb 100644 --- a/docs/promtail.md +++ b/docs/promtail.md @@ -29,7 +29,7 @@ The term "label" here is used in more than one different way and they can be eas * Labels starting with `__meta_kubernetes_pod_label_*` are "meta labels" which are generated based on your kubernetes pod labels. Example: If your kubernetes pod has a label "name" set to "foobar" then the scrape_configs section will have a label `__meta_kubernetes_pod_label_name` with value set to "foobar". -* There are other `__meta_kubernetes_*` labels based on the Kubernetes metadadata, such as the namespace the pod is +* There are other `__meta_kubernetes_*` labels based on the Kubernetes metadata, such as the namespace the pod is running (`__meta_kubernetes_namespace`) or the name of the container inside the pod (`__meta_kubernetes_pod_container_name`) * The label `__path__` is a special label which Promtail will read to find out where the log files are to be read in. * The label `filename` is added for every file found in `__path__` to ensure uniqueness of the streams. It contains the absolute path of the file being tailed. @@ -100,7 +100,7 @@ See [Processing Log Lines](./logentry/processing-log-lines.md) for a detailed pi #### Labels -[The original design doc](./design/labels.md) for labels. Post implementation we have strayed quit a bit from the config examples, though the pipeline idea was maintained. +[The original design doc](./design-documents/labels.md) for labels. Post implementation we have strayed quit a bit from the config examples, though the pipeline idea was maintained. See the [pipeline label docs](./logentry/processing-log-lines.md#labels) for more info on creating labels from log content. diff --git a/docs/promtail/api.md b/docs/promtail/api.md index a60d3b663a1e..965ef201f87b 100644 --- a/docs/promtail/api.md +++ b/docs/promtail/api.md @@ -8,7 +8,7 @@ Promtail features an embedded web server exposing a web console at `/` and the f ### `GET /metrics` - This endpoint returns Promtail metrics for Prometheus. See "[Operations > Observability > Metrics](./operations.md)" to have a list of exported metrics. + This endpoint returns Promtail metrics for Prometheus. See "[Operations > Observability > Metrics](../loki/operations.md)" to have a list of exported metrics. ## Promtail web server config diff --git a/docs/promtail/config-examples.md b/docs/promtail/config-examples.md index a7497dc7a355..86c1f8775063 100644 --- a/docs/promtail/config-examples.md +++ b/docs/promtail/config-examples.md @@ -2,7 +2,7 @@ ## Pipeline Examples -[Pipeline Docs](./logentry/processing-log-lines.md) contains detailed documentation of the pipeline stages +[Pipeline Docs](../logentry/processing-log-lines.md) contains detailed documentation of the pipeline stages ## Simple Docker Config diff --git a/docs/promtail/configuration.md b/docs/promtail/configuration.md index e86a9a8cc748..0d5f139813e0 100644 --- a/docs/promtail/configuration.md +++ b/docs/promtail/configuration.md @@ -134,7 +134,7 @@ bearer_token_file: /path/to/bearer/token/file # Configures the promtail request's TLS settings. tls_config: # CA certificate to validate API server certificate with. - # If not provided Trusted CA from sytem will be used. + # If not provided Trusted CA from system will be used. ca_file: # Certificate and key files for client cert authentication to the server. diff --git a/docs/promtail/deployment-methods.md b/docs/promtail/deployment-methods.md index a254de16e8af..7307b87de9fd 100644 --- a/docs/promtail/deployment-methods.md +++ b/docs/promtail/deployment-methods.md @@ -214,7 +214,7 @@ clients: # Configures the promtail request's TLS settings. tls_config: # CA certificate to validate API server certificate with. - # If not provided Trusted CA from sytem will be used. + # If not provided Trusted CA from system will be used. ca_file: # Certificate and key files for client cert authentication to the server.