diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 1270ad2a35..1edb61042d 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -12,8 +12,8 @@ A clear and concise description of what the bug is. **To Reproduce** Steps to reproduce the behavior: -1. Started loki (SHA or version) -2. Started promtail (SHA or version) to tail '...' +1. Started Loki (SHA or version) +2. Started Promtail (SHA or version) to tail '...' 3. Query: `{} term` **Expected behavior** @@ -23,5 +23,5 @@ A clear and concise description of what you expected to happen. - Infrastructure: [e.g., Kubernetes, bare-metal, laptop] - Deployment tool: [e.g., helm, jsonnet] -**Screenshots, promtail config, or terminal output** +**Screenshots, Promtail config, or terminal output** If applicable, add any output to help explain your problem. diff --git a/cmd/docker-driver/README.md b/cmd/docker-driver/README.md index 1a1d54429d..101618c0b9 100644 --- a/cmd/docker-driver/README.md +++ b/cmd/docker-driver/README.md @@ -37,7 +37,7 @@ The Docker daemon on each Docker host has a default logging driver; each contain When you start a container, you can configure it to use a different logging driver than the Docker daemon’s default, using the `--log-driver` flag. If the logging driver has configurable options, you can set them using one or more instances of the `--log-opt =` flag. Even if the container uses the default logging driver, it can use different configurable options. -The following command configure the container `grafana` to start with the loki drivers which will send logs to `logs-us-west1.grafana.net` Loki instance, using a batch size of 400 entries and will retry maximum 5 times if it fails. +The following command configure the container `grafana` to start with the Loki drivers which will send logs to `logs-us-west1.grafana.net` Loki instance, using a batch size of 400 entries and will retry maximum 5 times if it fails. ```bash docker run --log-driver=loki \ diff --git a/debug/README.md b/debug/README.md index b4e571325a..564e4cb10a 100644 --- a/debug/README.md +++ b/debug/README.md @@ -11,7 +11,7 @@ You can use the `docker-compose.yaml` in this directory to launch the debug vers ## Promtail in kubernetes -If you want to debug promtail in kubernetes, I have done so with the ksonnet setup: +If you want to debug Promtail in kubernetes, I have done so with the ksonnet setup: ```shell ks init promtail @@ -48,9 +48,9 @@ promtail + { } ``` -change the `some_cluster_name` to anything meaningful to help find your logs in loki +change the `some_cluster_name` to anything meaningful to help find your logs in Loki -also update the `hostname`, `username`, and `password` for your loki instance. +also update the `hostname`, `username`, and `password` for your Loki instance. ## Loki in kubernetes diff --git a/docs/clients/promtail/configuration.md b/docs/clients/promtail/configuration.md index 2674ea705d..c2bc7c502a 100644 --- a/docs/clients/promtail/configuration.md +++ b/docs/clients/promtail/configuration.md @@ -60,7 +60,7 @@ Supported contents and default values of `config.yaml`: # Configures the server for Promtail. [server: ] -# Describes how promtail connects to multiple instances +# Describes how Promtail connects to multiple instances # of Loki, sending logs to each. clients: - [] @@ -226,7 +226,7 @@ The `scrape_config` block configures how Promtail can scrape logs from a series of targets using a specified discovery method: ```yaml -# Name to identify this scrape config in the promtail UI. +# Name to identify this scrape config in the Promtail UI. job_name: # Describes how to parse log lines. Suported values [cri docker raw] diff --git a/docs/clients/promtail/pipelines.md b/docs/clients/promtail/pipelines.md index 72bd64883b..012088abf3 100644 --- a/docs/clients/promtail/pipelines.md +++ b/docs/clients/promtail/pipelines.md @@ -137,7 +137,7 @@ scrape_configs: expression: ".*(?Ppanic: .*)" # The metrics stage is going to increment a panic_total metric counter - # which promtail exposes. The counter is only incremented when panic + # which Promtail exposes. The counter is only incremented when panic # was extracted from the regex stage. - metrics: - panic_total: @@ -179,7 +179,7 @@ The final value for the timestamp is sent to Loki. ##### Log Line The current log line, represented as text. Initialized to be the text that -promtail scraped. Action stages can modify this value. +Promtail scraped. Action stages can modify this value. The final value for the log line is sent to Loki as the text content for the given log entry. diff --git a/docs/design-documents/labels.md b/docs/design-documents/labels.md index 9b44650f19..6a885c22fa 100644 --- a/docs/design-documents/labels.md +++ b/docs/design-documents/labels.md @@ -56,7 +56,7 @@ The Docker log format is an example where multiple levels of processing may be r A pipelined approach should allow for handling these more challenging scenarios -There are 2 interfaces within promtail already that should support constructing a pipeline: +There are 2 interfaces within Promtail already that should support constructing a pipeline: ```go type EntryMiddleware interface { diff --git a/docs/operations/authentication.md b/docs/operations/authentication.md index fdf71bb11d..d2d468c6a2 100644 --- a/docs/operations/authentication.md +++ b/docs/operations/authentication.md @@ -10,5 +10,5 @@ of populating this value should be handled by the authenticating reverse proxy. For more information on multi-tenancy please read its [documentation](multi-tenancy.md). -For information on authenticating promtail, please see the docs for [how to +For information on authenticating Promtail, please see the docs for [how to configure Promtail](../clients/promtail/configuration.md). diff --git a/production/README.md b/production/README.md index 6d5b8661fc..26612f97e7 100644 --- a/production/README.md +++ b/production/README.md @@ -20,7 +20,7 @@ The demo includes complimentary metrics (Prometheus or Graphite) that help illus The Docker images for [Loki](https://hub.docker.com/r/grafana/loki/) and [Promtail](https://hub.docker.com/r/grafana/promtail/) are available on DockerHub. -To test locally, we recommend using the `docker-compose.yaml` file in this directory. Docker starts containers for promtail, Loki, and Grafana. +To test locally, we recommend using the `docker-compose.yaml` file in this directory. Docker starts containers for Promtail, Loki, and Grafana. 1. Either `git clone` this repository locally and `cd loki/production`, or download a copy of the [docker-compose.yaml](docker-compose.yaml) locally. @@ -38,14 +38,14 @@ To test locally, we recommend using the `docker-compose.yaml` file in this direc 1. Grafana should now be available at http://localhost:3000/. Log in with `admin` / `admin` and follow the [steps for configuring the datasource in Grafana](../docs/querying.md#grafana), using `http://loki:3100` for the URL field. -**Note:** When running locally, promtail starts before loki is ready. This can lead to the error message "Data source connected, but no labels received." After a couple seconds, Promtail will forward all newly created log messages correctly. +**Note:** When running locally, Promtail starts before Loki is ready. This can lead to the error message "Data source connected, but no labels received." After a couple seconds, Promtail will forward all newly created log messages correctly. Until this is fixed we recommend [building and running from source](#build-and-run-from-source). For instructions on how to query Loki, see [our usage docs](../docs/querying.md). ## Using Helm to deploy on Kubernetes -There is a [Helm chart](helm) to deploy Loki and promtail to Kubernetes. +There is a [Helm chart](helm) to deploy Loki and Promtail to Kubernetes. ## Build and run from source @@ -69,7 +69,7 @@ To build Promtail on non-Linux platforms, use the following command: $ go build ./cmd/promtail ``` -On Linux, promtail requires the systemd headers to be installed for +On Linux, Promtail requires the systemd headers to be installed for Journal support. With Journal support on Ubuntu, run with the following commands: @@ -86,7 +86,7 @@ $ sudo yum install -y systemd-devel $ go build ./cmd/promtail ``` -Otherwise, to build promtail without Journal support, run `go build` +Otherwise, to build Promtail without Journal support, run `go build` with CGO disabled: ```bash @@ -108,7 +108,7 @@ $ docker run -ti -p 3000:3000 grafana/grafana:master Grafana should now be available at http://localhost:3000/. Follow the [steps for configuring the datasource in Grafana](../docs/querying.md) and set the URL field to `http://host.docker.internal:3100`. -For instructions on how to use loki, see [our usage docs](../docs/querying.md). +For instructions on how to use Loki, see [our usage docs](../docs/querying.md). ## Get inspired by our production setup diff --git a/production/helm/README.md b/production/helm/README.md index 5f850bc767..3cc7cc3173 100644 --- a/production/helm/README.md +++ b/production/helm/README.md @@ -92,7 +92,7 @@ Then follow the [instructions for adding the loki datasource](/docs/querying.md# If Loki and Promtail are deployed on different clusters you can add an Ingress in front of Loki. By adding a certificate you create an https endpoint. For extra security enable basic authentication on the Ingress. -In promtail set the following values to communicate with https and basic auth +In Promtail set the following values to communicate with https and basic auth ``` loki: diff --git a/production/ksonnet/README.md b/production/ksonnet/README.md index 245994bc30..7ebbec5670 100644 --- a/production/ksonnet/README.md +++ b/production/ksonnet/README.md @@ -25,7 +25,7 @@ $ jb install github.com/ksonnet/ksonnet-lib/ksonnet.beta.3/k8s.libsonnet ## Deploying Promtail to your cluster. -Grab the promtail module using jb: +Grab the `promtail` module using jb: ``` $ jb install github.com/grafana/loki/production/ksonnet/promtail