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.

Sign up for GitHub

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

Jump to bottom

Rework logging defaults #1927

Merged
merged 4 commits into from
Mar 28, 2024
Merged

Rework logging defaults #1927

merged 4 commits into from
Mar 28, 2024

Conversation

matt0x6F
Copy link
Contributor

@matt0x6F matt0x6F commented Mar 21, 2024 •
edited
Loading

What is the problem I am trying to address?

#1926 made configuring the JSON logger more obvious, however, it omitted that there is a requirement to change CloudRuntime to something other than none in order for it to work. This uses the plain text logger (aka dev formatter) as the plaintext configuration.

How is the fix applied?

Remove none case, and use devFormatter as the plain and blank option.

What GitHub issue(s) does this PR fix or close?

Closes #1924

Note: This will cause anyone not configuring a cloudruntime or setting format to plain to by default see logs in json. If this is absolutely breaking or undesireable we can change the default to plain in the configuration.

@matt0x6F matt0x6F self-assigned this Mar 21, 2024
@matt0x6F matt0x6F requested a review from a team as a code owner March 21, 2024 23:29
@matt0x6F
Copy link
Contributor Author

@nrwiersma I have two commits here. One sets the JSON logger as a default when CloudRuntime is none and the other sets json as the default. I can't totally match the original behavior, because before you had to set CloudRuntime to something other than none in order to get the JSON logger, but plain was what came with the default config.

Any thoughts or preferences?

@matt0x6F matt0x6F added this to the 0.13.2 milestone Mar 26, 2024
@nrwiersma
Copy link
Contributor

@matt0x6F I would try keep the default behaviour of plain, as IMO changing this would affect the most people. From there the config changes are what they are.

@matt0x6F
Copy link
Contributor Author

Sounds good, the latest commit restores the default behavior

@matt0x6F matt0x6F merged commit b9c8fb7 into gomods:main Mar 28, 2024
11 checks passed
@matt0x6F matt0x6F deleted the rework-logging-defaults branch March 28, 2024 00:48
DrPsychick referenced this pull request in gomods/athens-charts Apr 16, 2024
@renovate
chore(deps): update gomods/athens docker tag to v0.13.3 (#65)
cbb9f53 
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Update | Change |
|---|---|---|
| [gomods/athens](https://togithub.com/gomods/athens) | patch |
`v0.13.1` -> `v0.13.3` |

---

### Release Notes

<details>
<summary>gomods/athens (gomods/athens)</summary>

### [`v0.13.3`](https://togithub.com/gomods/athens/releases/tag/v0.13.3)

[Compare
Source](https://togithub.com/gomods/athens/compare/v0.13.2...v0.13.3)

#### What's Changed

- Update README.md by
[@&#8203;computerscienceiscool](https://togithub.com/computerscienceiscool)
in
[https://github.com/gomods/athens/pull/1932](https://togithub.com/gomods/athens/pull/1932)
- update-go-pkg(deps): bump github.com/stretchr/testify from 1.8.4 to
1.9.0 by [@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/gomods/athens/pull/1933](https://togithub.com/gomods/athens/pull/1933)
- Upgrade logrus from 1.7.0 => 1.9.3 by
[@&#8203;matt0x6F](https://togithub.com/matt0x6F) in
[https://github.com/gomods/athens/pull/1934](https://togithub.com/gomods/athens/pull/1934)
- should use errors.AsErr to extract and detect errors.Error by
[@&#8203;kkHAIKE](https://togithub.com/kkHAIKE) in
[https://github.com/gomods/athens/pull/1936](https://togithub.com/gomods/athens/pull/1936)
- correcting the misuse of the context in the copyContextWithCustomTime…
by [@&#8203;kkHAIKE](https://togithub.com/kkHAIKE) in
[https://github.com/gomods/athens/pull/1941](https://togithub.com/gomods/athens/pull/1941)
- remove hardcoded rootPath values by
[@&#8203;Jeansen](https://togithub.com/Jeansen) in
[https://github.com/gomods/athens/pull/1874](https://togithub.com/gomods/athens/pull/1874)

#### New Contributors

-
[@&#8203;computerscienceiscool](https://togithub.com/computerscienceiscool)
made their first contribution in
[https://github.com/gomods/athens/pull/1932](https://togithub.com/gomods/athens/pull/1932)
- [@&#8203;kkHAIKE](https://togithub.com/kkHAIKE) made their first
contribution in
[https://github.com/gomods/athens/pull/1936](https://togithub.com/gomods/athens/pull/1936)
- [@&#8203;Jeansen](https://togithub.com/Jeansen) made their first
contribution in
[https://github.com/gomods/athens/pull/1874](https://togithub.com/gomods/athens/pull/1874)

**Full Changelog**:
gomods/athens@v0.13.2...v0.13.3

### [`v0.13.2`](https://togithub.com/gomods/athens/releases/tag/v0.13.2)

[Compare
Source](https://togithub.com/gomods/athens/compare/v0.13.1...v0.13.2)

#### What's Changed

- Send standard logger's output to logrus by
[@&#8203;mikesep](https://togithub.com/mikesep) in
[https://github.com/gomods/athens/pull/1912](https://togithub.com/gomods/athens/pull/1912)
- chore: fix broken links to 'absolutely everybody' blog post by
[@&#8203;darrylblake](https://togithub.com/darrylblake) in
[https://github.com/gomods/athens/pull/1914](https://togithub.com/gomods/athens/pull/1914)
- update-github-action(deps): bump golangci/golangci-lint-action from 3
to 4 by [@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/gomods/athens/pull/1915](https://togithub.com/gomods/athens/pull/1915)
- update-go-pkg(deps): bump github.com/gorilla/mux from 1.6.2 to 1.8.1
by [@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/gomods/athens/pull/1917](https://togithub.com/gomods/athens/pull/1917)
- update-go-pkg(deps): bump github.com/stretchr/testify from 1.8.1 to
1.8.4 by [@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/gomods/athens/pull/1918](https://togithub.com/gomods/athens/pull/1918)
- update-go-pkg(deps): bump go.etcd.io/etcd/api/v3 from 3.5.9 to 3.5.12
by [@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/gomods/athens/pull/1919](https://togithub.com/gomods/athens/pull/1919)
- Fix Markdown link in Storage docs by
[@&#8203;chriskuehl](https://togithub.com/chriskuehl) in
[https://github.com/gomods/athens/pull/1922](https://togithub.com/gomods/athens/pull/1922)
- Use quotes for args by
[@&#8203;matt0x6F](https://togithub.com/matt0x6F) in
[https://github.com/gomods/athens/pull/1925](https://togithub.com/gomods/athens/pull/1925)
- Add log formatting settings by
[@&#8203;matt0x6F](https://togithub.com/matt0x6F) in
[https://github.com/gomods/athens/pull/1926](https://togithub.com/gomods/athens/pull/1926)
- upgrade mongodb driver by
[@&#8203;xytan0056](https://togithub.com/xytan0056) in
[https://github.com/gomods/athens/pull/1928](https://togithub.com/gomods/athens/pull/1928)
- update-go-pkg(deps): bump github.com/lib/pq from 1.10.7 to 1.10.9 by
[@&#8203;dependabot](https://togithub.com/dependabot) in
[https://github.com/gomods/athens/pull/1923](https://togithub.com/gomods/athens/pull/1923)
- Rework logging defaults by
[@&#8203;matt0x6F](https://togithub.com/matt0x6F) in
[https://github.com/gomods/athens/pull/1927](https://togithub.com/gomods/athens/pull/1927)

#### New Contributors

- [@&#8203;darrylblake](https://togithub.com/darrylblake) made their
first contribution in
[https://github.com/gomods/athens/pull/1914](https://togithub.com/gomods/athens/pull/1914)
- [@&#8203;chriskuehl](https://togithub.com/chriskuehl) made their first
contribution in
[https://github.com/gomods/athens/pull/1922](https://togithub.com/gomods/athens/pull/1922)
- [@&#8203;matt0x6F](https://togithub.com/matt0x6F) made their first
contribution in
[https://github.com/gomods/athens/pull/1925](https://togithub.com/gomods/athens/pull/1925)

**Full Changelog**:
gomods/athens@v0.13.1...v0.13.2

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined),
Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/gomods/athens-charts).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4zMDEuNCIsInVwZGF0ZWRJblZlciI6IjM3LjMwMS40IiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6W119-->

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nrwiersma nrwiersma nrwiersma approved these changes

Assignees

@matt0x6F matt0x6F

Labels
None yet
Projects
None yet
Milestone
0.13.2
Development

Successfully merging this pull request may close these issues.

Coupling of CloudRuntime (ATHENS_CLOUD_RUNTIME) config var with log formatting is unexpected
2 participants
@matt0x6F @nrwiersma