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 log configuration #11211

Merged
merged 4 commits into from
Dec 4, 2023
Merged

Update log configuration #11211

merged 4 commits into from
Dec 4, 2023

Conversation

doanbutar
Copy link
Contributor

@doanbutar doanbutar commented Nov 11, 2023

What this PR does / why we need it:

Which issue(s) this PR fixes:
Fixes #

Special notes for your reviewer:

Checklist

  • Reviewed the CONTRIBUTING.md guide (required)
  • Documentation added
  • Tests updated
  • CHANGELOG.md updated
    • If the change is worth mentioning in the release notes, add add-to-release-notes label
  • Changes that require user attention or interaction to upgrade are documented in docs/sources/setup/upgrade/_index.md
  • For Helm chart changes bump the Helm chart version in production/helm/loki/Chart.yaml and update production/helm/loki/CHANGELOG.md and production/helm/loki/README.md. Example PR
  • If the change is deprecating or removing a configuration option, update the deprecated-config.yaml and deleted-config.yaml files respectively in the tools/deprecated-config-checker directory. Example PR

@doanbutar doanbutar requested a review from a team as a code owner November 11, 2023 03:07
@CLAassistant
Copy link

CLAassistant commented Nov 11, 2023

CLA assistant check
All committers have signed the CLA.

@github-actions github-actions bot added the type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories label Nov 11, 2023
@doanbutar
Copy link
Contributor Author

doanbutar commented Nov 11, 2023

Feedback from the customer:

Hi team, I've worked out the issue with Fluent Bit. It turns out the docs incorrectly state the "Name" parameter in the agent configuration as "grafana-loki", when it's supposed to be "loki". It also recommends using "Url" as a parameter, when in fact it's supposed to be "httpusername", "httppasswd" and "host".

here's the Terraform code for it:

    logConfiguration = {
      logDriver = "awsfirelens"

      options = {
        Name        = "loki"
        Labels      = "{env=\"${var.environment}\",job=\"${var.name}\"}"
        Remove_Keys = "$container_id,$ecs_task_arn"
        Label_Keys  = "$container_name,$ecs_task_definition,$source,$ecs_cluster"
        Line_Format = "key_value"
        Host        = "logs-prod-026.grafana.net"
        Http_User   = "695835"

      }

      secretOptions = [{
        name      = "Http_Passwd"
        valueFrom = data.aws_secretsmanager_secret.grafana_cloud_loki_http_password.id
      }]
    }

The other parameter names needed to be updated as well to include underscores, while the *_Keys parameters expect dollar signs at the start of each reference key, as seen above.

Finally, this config works for the latest images: grafana/fluent-bit-plugin-loki:latest

Copy link
Contributor

github-actions bot commented Nov 11, 2023

Trivy scan found the following vulnerabilities:

Copy link
Contributor

@JStickler JStickler left a comment

Choose a reason for hiding this comment

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

[docs team] LGTM

@JStickler JStickler merged commit 7f79db9 into main Dec 4, 2023
8 checks passed
@JStickler JStickler deleted the doanbutar-patch-3 branch December 4, 2023 21:28
grafanabot pushed a commit that referenced this pull request Dec 4, 2023
**What this PR does / why we need it**:

**Which issue(s) this PR fixes**:
Fixes #<issue number>

**Special notes for your reviewer**:

**Checklist**
- [ ] Reviewed the
[`CONTRIBUTING.md`](https://github.com/grafana/loki/blob/main/CONTRIBUTING.md)
guide (**required**)
- [ ] Documentation added
- [ ] Tests updated
- [ ] `CHANGELOG.md` updated
- [ ] If the change is worth mentioning in the release notes, add
`add-to-release-notes` label
- [ ] Changes that require user attention or interaction to upgrade are
documented in `docs/sources/setup/upgrade/_index.md`
- [ ] For Helm chart changes bump the Helm chart version in
`production/helm/loki/Chart.yaml` and update
`production/helm/loki/CHANGELOG.md` and
`production/helm/loki/README.md`. [Example
PR](d10549e)
- [ ] If the change is deprecating or removing a configuration option,
update the `deprecated-config.yaml` and `deleted-config.yaml` files
respectively in the `tools/deprecated-config-checker` directory.
[Example
PR](0d4416a)

---------

Co-authored-by: J Stickler <[email protected]>
(cherry picked from commit 7f79db9)
JStickler pushed a commit that referenced this pull request Dec 4, 2023
Backport 7f79db9 from #11211

---

**What this PR does / why we need it**:

**Which issue(s) this PR fixes**:
Fixes #<issue number>

**Special notes for your reviewer**:

**Checklist**
- [ ] Reviewed the
[`CONTRIBUTING.md`](https://github.com/grafana/loki/blob/main/CONTRIBUTING.md)
guide (**required**)
- [ ] Documentation added
- [ ] Tests updated
- [ ] `CHANGELOG.md` updated
- [ ] If the change is worth mentioning in the release notes, add
`add-to-release-notes` label
- [ ] Changes that require user attention or interaction to upgrade are
documented in `docs/sources/setup/upgrade/_index.md`
- [ ] For Helm chart changes bump the Helm chart version in
`production/helm/loki/Chart.yaml` and update
`production/helm/loki/CHANGELOG.md` and
`production/helm/loki/README.md`. [Example
PR](d10549e)
- [ ] If the change is deprecating or removing a configuration option,
update the `deprecated-config.yaml` and `deleted-config.yaml` files
respectively in the `tools/deprecated-config-checker` directory.
[Example
PR](0d4416a)

Co-authored-by: Pangidoan Butar <[email protected]>
rhnasc pushed a commit to inloco/loki that referenced this pull request Apr 12, 2024
**What this PR does / why we need it**:

**Which issue(s) this PR fixes**:
Fixes #<issue number>

**Special notes for your reviewer**:

**Checklist**
- [ ] Reviewed the
[`CONTRIBUTING.md`](https://github.com/grafana/loki/blob/main/CONTRIBUTING.md)
guide (**required**)
- [ ] Documentation added
- [ ] Tests updated
- [ ] `CHANGELOG.md` updated
- [ ] If the change is worth mentioning in the release notes, add
`add-to-release-notes` label
- [ ] Changes that require user attention or interaction to upgrade are
documented in `docs/sources/setup/upgrade/_index.md`
- [ ] For Helm chart changes bump the Helm chart version in
`production/helm/loki/Chart.yaml` and update
`production/helm/loki/CHANGELOG.md` and
`production/helm/loki/README.md`. [Example
PR](grafana@d10549e)
- [ ] If the change is deprecating or removing a configuration option,
update the `deprecated-config.yaml` and `deleted-config.yaml` files
respectively in the `tools/deprecated-config-checker` directory.
[Example
PR](grafana@0d4416a)

---------

Co-authored-by: J Stickler <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport release-2.9.x size/S type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants