Skip to content

Commit

Permalink
Docs: correctly represent product name (#4416)
Browse files Browse the repository at this point in the history
The product name is Grafana Loki.  The first use of the product name on
each web page should be the full product name.  After that, within each
page, it is fine to use just Loki.

This PR also set up some frontmatter with weights where it was missing
on a few files, and correct where "Loki" was not capitalized.
  • Loading branch information
KMiller-Grafana authored Oct 5, 2021
1 parent e6e8cbf commit 24accf6
Show file tree
Hide file tree
Showing 58 changed files with 96 additions and 85 deletions.
4 changes: 2 additions & 2 deletions docs/sources/_index.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: Loki Documentation
title: Grafana Loki
aliases:
- /docs/loki/
---

# Loki Documentation
# Grafana Loki Documentation

<p align="center"> <img src="logo_and_name.png" alt="Loki Logo"> <br>
<small>Like Prometheus, but for logs!</small> </p>
Expand Down
4 changes: 2 additions & 2 deletions docs/sources/api/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ title: HTTP API
weight: 900
---

# Loki HTTP API
# Grafana Loki HTTP API

Loki exposes an HTTP API for pushing, querying, and tailing log data.
Grafana Loki exposes an HTTP API for pushing, querying, and tailing log data.
Note that [authenticating](../operations/authentication/) against the API is
out of scope for Loki.

Expand Down
4 changes: 2 additions & 2 deletions docs/sources/best-practices/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
title: Best practices
weight: 400
---
# Loki label best practices
# Grafana Loki label best practices

Loki is under active development, and we are constantly working to improve performance. But here are some of the most current best practices for labels that will give you the best experience with Loki.
Grafana Loki is under active development, and we are constantly working to improve performance. But here are some of the most current best practices for labels that will give you the best experience with Loki.

## Static labels are good

Expand Down
4 changes: 2 additions & 2 deletions docs/sources/clients/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
title: Clients
weight: 600
---
# Loki clients
# Grafana Loki clients

Loki supports the following official clients for sending logs:
Grafana Loki supports the following official clients for sending logs:

- [Promtail](promtail/)
- [Docker Driver](docker-driver/)
Expand Down
3 changes: 2 additions & 1 deletion docs/sources/clients/aws/_index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
title: AWS
weight: 30
---

Sending logs from AWS services to Loki is a little different depending on what AWS service you are using:
Sending logs from AWS services to Grafana Loki is a little different depending on what AWS service you are using:

* [Elastic Compute Cloud (EC2)](ec2/)
* [Elastic Container Service (ECS)](ecs/)
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/clients/aws/ec2/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: EC2
---
# Running Promtail on AWS EC2

In this tutorial we're going to setup [Promtail](../../promtail/) on an AWS EC2 instance and configure it to sends all its logs to a Loki instance.
In this tutorial we're going to setup [Promtail](../../promtail/) on an AWS EC2 instance and configure it to sends all its logs to a Grafana Loki instance.

<!-- TOC -->

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/clients/aws/ecs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: ECS
---
# Sending Logs From AWS Elastic Container Service (ECS)

[ECS][ECS] is the fully managed container orchestration service by Amazon. Combined with [Fargate][Fargate] you can run your container workload without the need to provision your own compute resources. In this tutorial we will see how you can leverage [Firelens][Firelens] an AWS log router to forward all your logs and your workload metadata to a Loki instance.
[ECS][ECS] is the fully managed container orchestration service by Amazon. Combined with [Fargate][Fargate] you can run your container workload without the need to provision your own compute resources. In this tutorial we will see how you can leverage [Firelens][Firelens] an AWS log router to forward all your logs and your workload metadata to a Grafana Loki instance.

After this tutorial you will able to query all your logs in one place using Grafana.

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/clients/aws/eks/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Before we start you'll need:

- The [AWS CLI][aws cli] configured (run `aws configure`).
- [kubectl][kubectl] and [eksctl][eksctl] installed.
- A Grafana instance with a Loki data source already configured, you can use [GrafanaCloud][GrafanaCloud] free trial.
- A Grafana instance with a Grafana Loki data source already configured, you can use [GrafanaCloud][GrafanaCloud] free trial.

For the sake of simplicity we'll use a [GrafanaCloud][GrafanaCloud] Loki and Grafana instances, you can get an free account for this tutorial on our [website][GrafanaCloud], but all the steps are the same if you're running your own Open Source version of Loki and Grafana instances.

Expand Down
3 changes: 2 additions & 1 deletion docs/sources/clients/docker-driver/_index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
title: Docker driver
weight: 40
---
# Docker Driver Client

Loki officially supports a Docker plugin that will read logs from Docker
Grafana Loki officially supports a Docker plugin that will read logs from Docker
containers and ship them to Loki. The plugin can be configured to send the logs
to a private Loki instance or [Grafana Cloud](https://grafana.com/oss/loki).

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/clients/docker-driver/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ each container will use the default driver unless configured otherwise.

## Installation

Before configuring the plugin, [install or upgrade the Loki Docker Driver Client](../../docker-driver/)
Before configuring the plugin, [install or upgrade the Grafana Loki Docker Driver Client](../../docker-driver/)

## Change the logging driver for a container

Expand Down
3 changes: 2 additions & 1 deletion docs/sources/clients/fluentbit/_index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
title: Fluentbit
weight: 50
---
# Fluentbit Loki Output Plugin

[Fluent Bit](https://fluentbit.io/) is a Fast and Lightweight Data Forwarder, it can be configured with the [Loki output plugin](https://fluentbit.io/documentation/0.12/output/) to ship logs to Loki. You can define which log files you want to collect using the [`Tail`](https://fluentbit.io/documentation/0.12/input/tail.html) or [`Stdin`](https://docs.fluentbit.io/manual/pipeline/inputs/standard-input) [input plugin](https://fluentbit.io/documentation/0.12/getting_started/input.html). Additionally Fluent Bit supports multiple `Filter` and `Parser` plugins (`Kubernetes`, `JSON`, etc..) to structure and alter log lines.
[Fluent Bit](https://fluentbit.io/) is a Fast and Lightweight Data Forwarder, it can be configured with the [Grafana Loki output plugin](https://fluentbit.io/documentation/0.12/output/) to ship logs to Loki. You can define which log files you want to collect using the [`Tail`](https://fluentbit.io/documentation/0.12/input/tail.html) or [`Stdin`](https://docs.fluentbit.io/manual/pipeline/inputs/standard-input) [input plugin](https://fluentbit.io/documentation/0.12/getting_started/input.html). Additionally Fluent Bit supports multiple `Filter` and `Parser` plugins (`Kubernetes`, `JSON`, etc..) to structure and alter log lines.

## Usage

Expand Down
3 changes: 2 additions & 1 deletion docs/sources/clients/fluentd/_index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
title: Fluentd
weight: 60
---
# Fluentd Loki Output Plugin

Loki has a [Fluentd](https://www.fluentd.org/) output plugin called
Grafana Loki has a [Fluentd](https://www.fluentd.org/) output plugin called
`fluent-plugin-grafana-loki` that enables shipping logs to a private Loki
instance or [Grafana Cloud](https://grafana.com/products/cloud/).

Expand Down
3 changes: 2 additions & 1 deletion docs/sources/clients/lambda-promtail/_index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
title: Lambda Promtail
weight: 20
---
# Lambda Promtail

Loki includes an [AWS SAM](https://aws.amazon.com/serverless/sam/) package template for shipping Cloudwatch logs to Loki via a [set of Promtails](https://github.com/grafana/loki/tree/master/tools/lambda-promtail). This is done via an intermediary [lambda function](https://aws.amazon.com/lambda/) which processes cloudwatch events and propagates them to a Promtail instance (or set of instances behind a load balancer) via the push-api [scrape config](../promtail/configuration#loki_push_api_config).
Grafana Loki includes an [AWS SAM](https://aws.amazon.com/serverless/sam/) package template for shipping Cloudwatch logs to Loki via a [set of Promtails](https://github.com/grafana/loki/tree/master/tools/lambda-promtail). This is done via an intermediary [lambda function](https://aws.amazon.com/lambda/) which processes cloudwatch events and propagates them to a Promtail instance (or set of instances behind a load balancer) via the push-api [scrape config](../promtail/configuration#loki_push_api_config).

## Uses

Expand Down
3 changes: 2 additions & 1 deletion docs/sources/clients/logstash/_index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
title: Logstash
weight: 70
---
# Logstash

Loki has a [Logstash](https://www.elastic.co/logstash) output plugin called
Grafana Loki has a [Logstash](https://www.elastic.co/logstash) output plugin called
`logstash-output-loki` that enables shipping logs to a Loki
instance or [Grafana Cloud](https://grafana.com/products/cloud/).

Expand Down
3 changes: 2 additions & 1 deletion docs/sources/clients/promtail/_index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
title: Promtail
weight: 10
---
# Promtail

Promtail is an agent which ships the contents of local logs to a private Loki
Promtail is an agent which ships the contents of local logs to a private Grafana Loki
instance or [Grafana Cloud](https://grafana.com/oss/loki). It is usually
deployed to every machine that has applications needed to be monitored.

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/clients/promtail/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ Where default_value is the value to use if the environment variable is undefined
[server: <server_config>]

# Describes how Promtail connects to multiple instances
# of Loki, sending logs to each.
# of Grafana Loki, sending logs to each.
# WARNING: If one of the remote Loki servers fails to respond or responds
# with any error which is retryable, this will impact sending logs to any
# other configured remote Loki servers. Sending is done on a single thread!
Expand Down
6 changes: 3 additions & 3 deletions docs/sources/clients/promtail/gcplog-cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Cloud setup GCP Logs
---
# Cloud setup GCP logs

This document explain how one can setup Google Cloud Platform to forward its cloud resource logs from a particular GCP project into Google Pubsub topic so that is available for Loki Promtail to consume.
This document explain how one can setup Google Cloud Platform to forward its cloud resource logs from a particular GCP project into Google Pubsub topic so that is available for Promtail to consume.

This document assumes, that reader have `gcloud` installed and have required permissions(as mentioned in #[Roles and Permission] section)

Expand Down Expand Up @@ -46,7 +46,7 @@ For more information on adding `log-filter` refer this [document](https://cloud.

We cover more advanced `log-filter` [below](#Advanced-Log-filter)

## Create Pubsub subscription for Loki
## Create Pubsub subscription for Grafana Loki

We create subscription for the pubsub topic we create above and Promtail uses this subscription to consume log messages.

Expand Down Expand Up @@ -94,7 +94,7 @@ gcloud pubsub subscriptions seek projects/my-project/subscriptions/cloud-logs --

## Advanced log filter

So far we've covered admitting GCS bucket logs into Loki, but often one may need to add multiple cloud resource logs and may also need to exclude unnecessary logs. The following is a more complex example.
So far we've covered admitting GCS bucket logs into Grafana Loki, but often one may need to add multiple cloud resource logs and may also need to exclude unnecessary logs. The following is a more complex example.

We use the `log-filter` option to include logs and the `exclusion` option to exclude them.

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/clients/promtail/pipelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ something with that extracted data. The most common action stage will be a
A common stage will also be the [match](../stages/match/) stage to selectively
apply stages or drop entries based on a [LogQL stream selector and filter expressions](../../../logql/).

Note that pipelines can not currently be used to deduplicate logs; Loki will
Note that pipelines can not currently be used to deduplicate logs; Grafana Loki will
receive the same log line multiple times if, for example:

1. Two scrape configs read from the same file
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/clients/promtail/scraping.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ There are different types of labels present in Promtail:
- Labels starting with `__` (two underscores) are internal labels. They usually
come from dynamic sources like service discovery. Once relabeling is done,
they are removed from the label set. To persist internal labels so they're
sent to Loki, rename them so they don't start with `__`. See
sent to Grafana Loki, rename them so they don't start with `__`. See
[Relabeling](#relabeling) for more information.

- Labels starting with `__meta_kubernetes_pod_label_*` are "meta labels" which
Expand Down
4 changes: 2 additions & 2 deletions docs/sources/configuration/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
title: Configuration
weight: 500
---
# Configuring Loki
# Configuring Grafana Loki

Loki is configured in a YAML file (usually referred to as `loki.yaml` )
Grafana Loki is configured in a YAML file (usually referred to as `loki.yaml` )
which contains information on the Loki server and its individual components,
depending on which mode Loki is launched in.

Expand Down
4 changes: 2 additions & 2 deletions docs/sources/configuration/examples.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: Examples
---
# Loki Configuration Examples
# Grafana Loki Configuration Examples

## Complete Local config
## Complete Local configuration

```yaml
auth_enabled: false
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/configuration/query-frontend.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This aims to be a general purpose example; there are a number of substitutions t

## Use case

It's a common occurrence to start running Loki as a single binary while trying it out in order to simplify deployments and defer learning the (initially unnecessary) nitty gritty details. As we become more comfortable with its paradigms and begin migrating towards a more production ready deployment there are a number of things to be aware of. A common bottleneck is on the read path: queries that executed effortlessly on small data sets may churn to a halt on larger ones. Sometimes we can solve this with more queriers. However, that doesn't help when our queries are too large for a single querier to execute. Then we need the query frontend.
It's a common occurrence to start running Grafana Loki as a single binary while trying it out in order to simplify deployments and defer learning the (initially unnecessary) nitty gritty details. As we become more comfortable with its paradigms and begin migrating towards a more production ready deployment there are a number of things to be aware of. A common bottleneck is on the read path: queries that executed effortlessly on small data sets may churn to a halt on larger ones. Sometimes we can solve this with more queriers. However, that doesn't help when our queries are too large for a single querier to execute. Then we need the query frontend.

### Parallelization

Expand Down
4 changes: 2 additions & 2 deletions docs/sources/fundamentals/architecture/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ weight: 200
aliases:
- /docs/loki/latest/architecture/
---
# Loki's Architecture
# Grafana Loki's Architecture

## Multi-tenancy

All data, both in memory and in long-term storage, may be partitioned by a
tenant ID, pulled from the `X-Scope-OrgID` HTTP header in the request when Loki
tenant ID, pulled from the `X-Scope-OrgID` HTTP header in the request when Grafana Loki
is running in multi-tenant mode. When Loki is **not** in multi-tenant mode, the
header is ignored and the tenant ID is set to "fake", which will appear in the
index and in stored chunks.
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/fundamentals/architecture/distributor.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Distributors are stateless and communicate with ingesters via [gRPC](https://grp

## Where does it live?

The distributor is the first component on Loki's write path downstream from any gateways providing auth or load balancing. It's responsible for validating, preprocessing, and applying a subset of rate limiting to incoming data before sending it to the ingester component. It is important that a load balancer sits in front of the distributor in order to properly balance traffic to them.
The distributor is the first component on Grafana Loki's write path downstream from any gateways providing auth or load balancing. It's responsible for validating, preprocessing, and applying a subset of rate limiting to incoming data before sending it to the ingester component. It is important that a load balancer sits in front of the distributor in order to properly balance traffic to them.

## What does it do?

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/fundamentals/labels.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ aliases:

Labels are key value pairs and can be defined as anything! We like to refer to them as metadata to describe a log stream. If you are familiar with Prometheus, there are a few labels you are used to seeing like `job` and `instance`, and I will use those in the coming examples.

The scrape configs we provide with Loki define these labels, too. If you are using Prometheus, having consistent labels between Loki and Prometheus is one of Loki's superpowers, making it incredibly [easy to correlate your application metrics with your log data](https://grafana.com/blog/2019/05/06/how-loki-correlates-metrics-and-logs-and-saves-you-money/).
The scrape configs we provide with Grafana Loki define these labels, too. If you are using Prometheus, having consistent labels between Loki and Prometheus is one of Loki's superpowers, making it incredibly [easy to correlate your application metrics with your log data](https://grafana.com/blog/2019/05/06/how-loki-correlates-metrics-and-logs-and-saves-you-money/).

## How Loki uses labels

Expand Down
4 changes: 2 additions & 2 deletions docs/sources/fundamentals/overview/comparisons.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Comparisons
---
# Loki compared to other log systems

## Loki / Promtail / Grafana vs EFK
## Grafana Loki / Promtail / Grafana vs EFK

The EFK (Elasticsearch, Fluentd, Kibana) stack is used to ingest, visualize, and
query for logs from various sources.
Expand All @@ -13,7 +13,7 @@ keys for each object and the contents of each key are indexed. Data can then be
queried using a JSON object to define a query (called the Query DSL) or through
the Lucene query language.

In comparison, Loki in single-binary mode can store data on-disk, but in
In comparison, Grafana Loki in single-binary mode can store data on-disk, but in
horizontally-scalable mode data is stored in a cloud storage system such as S3,
GCS, or Cassandra. Logs are stored in plaintext form tagged with a set of label
names and values, where only the label pairs are indexed. This tradeoff makes it
Expand Down
2 changes: 1 addition & 1 deletion docs/sources/getting-started/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Getting started
weight: 300
---
# Getting started with Loki
# Getting started with Grafana Loki

> **Note:** You can use [Grafana Cloud](https://grafana.com/products/cloud/features/#cloud-logs) to avoid installing, maintaining, and scaling your own instance of Grafana Loki. The free forever plan includes 50GB of free logs. [Create a free account to get started](https://grafana.com/auth/sign-up/create-user?pg=docs-grafana-install&plcmt=in-text).
Expand Down
5 changes: 3 additions & 2 deletions docs/sources/getting-started/get-logs-into-loki.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
title: Get logs into Loki
weight: 10
---
# Get logs into Loki
# Get logs into Grafana Loki

After you [install and run Loki](../../installation/local/), you probably want to get logs from other applications into it.
After you [install and run Grafana Loki](../../installation/local/), you probably want to get logs from other applications into it.

To get application logs into Loki, you need to edit the [Promtail]({{< relref "../clients/promtail" >}}) configuration file.

Expand Down
3 changes: 2 additions & 1 deletion docs/sources/getting-started/grafana.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
---
title: Loki in Grafana
weight: 30
---
# Loki in Grafana

[Grafana 6.0](https://grafana.com/grafana/download/6.0.0) and more recent
versions have built-in support for Loki.
versions have built-in support for Grafana Loki.
Use [Grafana 6.3](https://grafana.com/grafana/download/6.3.0) or a more
recent version to take advantage of [LogQL]({{< relref "../logql/_index.md" >}}) functionality.

Expand Down
5 changes: 3 additions & 2 deletions docs/sources/getting-started/logcli.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
title: LogCLI
weight: 20
---
# LogCLI, Loki's command-line interface
# LogCLI, Grafana Loki's command-line interface

LogCLI is the command-line interface to Loki.
LogCLI is the command-line interface to Grafana Loki.
It facilitates running [LogQL]({{< relref "../logql/_index.md" >}})
queries against a Loki instance.

Expand Down
5 changes: 3 additions & 2 deletions docs/sources/getting-started/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
---
title: Troubleshooting
weight: 40
---
# Troubleshooting Loki
# Troubleshooting Grafana Loki

## "Loki: Bad Gateway. 502"

This error can appear in Grafana when Loki is added as a
This error can appear in Grafana when Grafana Loki is added as a
datasource, indicating that Grafana in unable to connect to Loki. There may
one of many root causes:

Expand Down
4 changes: 2 additions & 2 deletions docs/sources/installation/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
title: Docker
weight: 30
---
# Install Loki with Docker or Docker Compose
# Install Grafana Loki with Docker or Docker Compose

You can install Loki and Promtail with Docker or Docker Compose if you are evaluating, testing, or developing Loki.
You can install Grafana Loki and Promtail with Docker or Docker Compose if you are evaluating, testing, or developing Loki.
For production, we recommend installing with Tanka or Helm.

The configuration acquired with these installation instructions run Loki as a single binary.
Expand Down
4 changes: 2 additions & 2 deletions docs/sources/installation/helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
title: Helm
weight: 20
---
# Install Loki with Helm
# Install Grafana Loki with Helm

The Helm installation runs the Loki cluster as a single binary.
The Helm installation runs the Grafana Loki cluster as a single binary.

## Prerequisites

Expand Down
Loading

0 comments on commit 24accf6

Please sign in to comment.