Skip to content

Commit f3370cf

Browse files
pracuccirfratto
authored andcommitted
docs: fix Promtail / Loki capitalization (#1130)
* docs: fixed Promtail capitalization * docs: fixed Loki capitalization
1 parent 67f8ff8 commit f3370cf

File tree

10 files changed

+21
-21
lines changed

10 files changed

+21
-21
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ A clear and concise description of what the bug is.
1212

1313
**To Reproduce**
1414
Steps to reproduce the behavior:
15-
1. Started loki (SHA or version)
16-
2. Started promtail (SHA or version) to tail '...'
15+
1. Started Loki (SHA or version)
16+
2. Started Promtail (SHA or version) to tail '...'
1717
3. Query: `{} term`
1818

1919
**Expected behavior**
@@ -23,5 +23,5 @@ A clear and concise description of what you expected to happen.
2323
- Infrastructure: [e.g., Kubernetes, bare-metal, laptop]
2424
- Deployment tool: [e.g., helm, jsonnet]
2525

26-
**Screenshots, promtail config, or terminal output**
26+
**Screenshots, Promtail config, or terminal output**
2727
If applicable, add any output to help explain your problem.

cmd/docker-driver/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ The Docker daemon on each Docker host has a default logging driver; each contain
3737

3838
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 <NAME>=<VALUE>` flag. Even if the container uses the default logging driver, it can use different configurable options.
3939

40-
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.
40+
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.
4141

4242
```bash
4343
docker run --log-driver=loki \

debug/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ You can use the `docker-compose.yaml` in this directory to launch the debug vers
1111

1212
## Promtail in kubernetes
1313

14-
If you want to debug promtail in kubernetes, I have done so with the ksonnet setup:
14+
If you want to debug Promtail in kubernetes, I have done so with the ksonnet setup:
1515

1616
```shell
1717
ks init promtail
@@ -48,9 +48,9 @@ promtail + {
4848
}
4949
```
5050

51-
change the `some_cluster_name` to anything meaningful to help find your logs in loki
51+
change the `some_cluster_name` to anything meaningful to help find your logs in Loki
5252

53-
also update the `hostname`, `username`, and `password` for your loki instance.
53+
also update the `hostname`, `username`, and `password` for your Loki instance.
5454

5555
## Loki in kubernetes
5656

docs/clients/promtail/configuration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Supported contents and default values of `config.yaml`:
6060
# Configures the server for Promtail.
6161
[server: <server_config>]
6262

63-
# Describes how promtail connects to multiple instances
63+
# Describes how Promtail connects to multiple instances
6464
# of Loki, sending logs to each.
6565
clients:
6666
- [<client_config>]
@@ -226,7 +226,7 @@ The `scrape_config` block configures how Promtail can scrape logs from a series
226226
of targets using a specified discovery method:
227227

228228
```yaml
229-
# Name to identify this scrape config in the promtail UI.
229+
# Name to identify this scrape config in the Promtail UI.
230230
job_name: <string>
231231
232232
# Describes how to parse log lines. Suported values [cri docker raw]

docs/clients/promtail/pipelines.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ scrape_configs:
137137
expression: ".*(?P<panic>panic: .*)"
138138

139139
# The metrics stage is going to increment a panic_total metric counter
140-
# which promtail exposes. The counter is only incremented when panic
140+
# which Promtail exposes. The counter is only incremented when panic
141141
# was extracted from the regex stage.
142142
- metrics:
143143
- panic_total:
@@ -179,7 +179,7 @@ The final value for the timestamp is sent to Loki.
179179
##### Log Line
180180
181181
The current log line, represented as text. Initialized to be the text that
182-
promtail scraped. Action stages can modify this value.
182+
Promtail scraped. Action stages can modify this value.
183183
184184
The final value for the log line is sent to Loki as the text content for the
185185
given log entry.

docs/design-documents/labels.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ The Docker log format is an example where multiple levels of processing may be r
5656

5757
A pipelined approach should allow for handling these more challenging scenarios
5858

59-
There are 2 interfaces within promtail already that should support constructing a pipeline:
59+
There are 2 interfaces within Promtail already that should support constructing a pipeline:
6060

6161
```go
6262
type EntryMiddleware interface {

docs/operations/authentication.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,5 @@ of populating this value should be handled by the authenticating reverse proxy.
1010
For more information on multi-tenancy please read its
1111
[documentation](multi-tenancy.md).
1212

13-
For information on authenticating promtail, please see the docs for [how to
13+
For information on authenticating Promtail, please see the docs for [how to
1414
configure Promtail](../clients/promtail/configuration.md).

production/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The demo includes complimentary metrics (Prometheus or Graphite) that help illus
2020

2121
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.
2222

23-
To test locally, we recommend using the `docker-compose.yaml` file in this directory. Docker starts containers for promtail, Loki, and Grafana.
23+
To test locally, we recommend using the `docker-compose.yaml` file in this directory. Docker starts containers for Promtail, Loki, and Grafana.
2424

2525
1. Either `git clone` this repository locally and `cd loki/production`, or download a copy of the [docker-compose.yaml](docker-compose.yaml) locally.
2626

@@ -38,14 +38,14 @@ To test locally, we recommend using the `docker-compose.yaml` file in this direc
3838

3939
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.
4040

41-
**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.
41+
**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.
4242
Until this is fixed we recommend [building and running from source](#build-and-run-from-source).
4343

4444
For instructions on how to query Loki, see [our usage docs](../docs/querying.md).
4545

4646
## Using Helm to deploy on Kubernetes
4747

48-
There is a [Helm chart](helm) to deploy Loki and promtail to Kubernetes.
48+
There is a [Helm chart](helm) to deploy Loki and Promtail to Kubernetes.
4949

5050
## Build and run from source
5151

@@ -69,7 +69,7 @@ To build Promtail on non-Linux platforms, use the following command:
6969
$ go build ./cmd/promtail
7070
```
7171

72-
On Linux, promtail requires the systemd headers to be installed for
72+
On Linux, Promtail requires the systemd headers to be installed for
7373
Journal support.
7474

7575
With Journal support on Ubuntu, run with the following commands:
@@ -86,7 +86,7 @@ $ sudo yum install -y systemd-devel
8686
$ go build ./cmd/promtail
8787
```
8888

89-
Otherwise, to build promtail without Journal support, run `go build`
89+
Otherwise, to build Promtail without Journal support, run `go build`
9090
with CGO disabled:
9191

9292
```bash
@@ -108,7 +108,7 @@ $ docker run -ti -p 3000:3000 grafana/grafana:master
108108

109109
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`.
110110

111-
For instructions on how to use loki, see [our usage docs](../docs/querying.md).
111+
For instructions on how to use Loki, see [our usage docs](../docs/querying.md).
112112

113113
## Get inspired by our production setup
114114

production/helm/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ Then follow the [instructions for adding the loki datasource](/docs/querying.md#
9292
If Loki and Promtail are deployed on different clusters you can add an Ingress in front of Loki.
9393
By adding a certificate you create an https endpoint. For extra security enable basic authentication on the Ingress.
9494

95-
In promtail set the following values to communicate with https and basic auth
95+
In Promtail set the following values to communicate with https and basic auth
9696

9797
```
9898
loki:

production/ksonnet/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ $ jb install github.com/ksonnet/ksonnet-lib/ksonnet.beta.3/k8s.libsonnet
2525

2626
## Deploying Promtail to your cluster.
2727

28-
Grab the promtail module using jb:
28+
Grab the `promtail` module using jb:
2929

3030
```
3131
$ jb install github.com/grafana/loki/production/ksonnet/promtail

0 commit comments

Comments
 (0)