Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update fluent-plugin-loki documentation URLs #3880

Merged
merged 1 commit into from
Aug 9, 2021

Conversation

Coleslaw3557
Copy link
Contributor

Updated fluent-plugin-loki documentation links to point to new location. Original reference docs were moved in this commit.

What this PR does / why we need it:
Update to fluent-plugin-loki documented.
Which issue(s) this PR fixes:
Fixes #

Special notes for your reviewer:

Checklist

  • Documentation added
  • Tests updated

Updated fluent-plugin-loki documentation links to point to new location. Original reference docs were moved in this [commit](grafana@6e67d1e#diff-04dc5b2136328a0dcb189df97734c7c72e5e1227fa0c03469a6ce608f32f1b66).
@CLAassistant
Copy link

CLAassistant commented Jun 22, 2021

CLA assistant check
All committers have signed the CLA.

Copy link
Contributor

@sandeepsukhani sandeepsukhani left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks for the PR!

Copy link
Contributor

@KMiller-Grafana KMiller-Grafana left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I approve, given the suggested changes.

@@ -7,7 +7,7 @@ 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/).

The code source of the plugin is located in our [public repository](https://github.com/grafana/loki/tree/master/cmd/fluentd).
The code source of the plugin is located in our [public repository](https://github.com/grafana/loki/tree/main/clients/cmd/fluentd).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The code source of the plugin is located in our [public repository](https://github.com/grafana/loki/tree/main/clients/cmd/fluentd).
The plugin source code is in the [fluentd directory of the repository](https://github.com/grafana/loki/tree/main/clients/cmd/fluentd).

@@ -21,7 +21,7 @@ fluent-gem install fluent-plugin-grafana-loki

## Docker Image

There is a Docker image `grafana/fluent-plugin-loki:master` which contains [default configuration files](https://github.com/grafana/loki/tree/master/fluentd/fluent-plugin-loki/docker/conf). By default, fluentd containers use the configurations but you can also specify your `fluentd.conf` with `FLUENTD_CONF` environment variable.
There is a Docker image `grafana/fluent-plugin-loki:master` which contains [default configuration files](https://github.com/grafana/loki/tree/main/clients/cmd/fluentd/docker/conf). By default, fluentd containers use the configurations but you can also specify your `fluentd.conf` with `FLUENTD_CONF` environment variable.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I find this paragraph confusing. Here's my suggested rewrite, given my questionable understanding of what was meant to be conveyed.

Suggested change
There is a Docker image `grafana/fluent-plugin-loki:master` which contains [default configuration files](https://github.com/grafana/loki/tree/main/clients/cmd/fluentd/docker/conf). By default, fluentd containers use the configurations but you can also specify your `fluentd.conf` with `FLUENTD_CONF` environment variable.
The Docker image `grafana/fluent-plugin-loki:master` contains [default configuration files](https://github.com/grafana/loki/tree/main/clients/cmd/fluentd/docker/conf). By default, fluentd containers use that default configuration. You can instead specify your `fluentd.conf` configuration file with a `FLUENTD_CONF` environment variable.

Comment on lines 180 to 182
### url

The url of the Loki server to send logs to. When sending data the publish path (`../api/loki/v1/push`) will automatically be appended.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please also update this prose, even though your PR did not originally touch this prose:

URL

The URL of the Loki server to send logs to. When sending data, the publish path (../api/loki/v1/push) will automatically be appended.

Comment on lines 180 to 182
### url

The url of the Loki server to send logs to. When sending data the publish path (`../api/loki/v1/push`) will automatically be appended.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please also update this prose, even though your PR did not originally touch this prose.

Suggested change
### url
The url of the Loki server to send logs to. When sending data the publish path (`../api/loki/v1/push`) will automatically be appended.
### URL
The URL of the Loki server to send logs to. When sending data, the publish path (`../api/loki/v1/push`) will automatically be appended.

@stale
Copy link

stale bot commented Jul 29, 2021

This issue has been automatically marked as stale because it has not had any activity in the past 30 days. It will be closed in 7 days if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale A stale issue or PR that will automatically be closed. label Jul 29, 2021
@stale stale bot closed this Aug 5, 2021
@owen-d owen-d reopened this Aug 9, 2021
@stale stale bot removed the stale A stale issue or PR that will automatically be closed. label Aug 9, 2021
@owen-d owen-d merged commit b3d7740 into grafana:main Aug 9, 2021
KMiller-Grafana added a commit to KMiller-Grafana/loki that referenced this pull request Aug 11, 2021
slim-bean pushed a commit that referenced this pull request Aug 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants