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

fix: correct misleading error message for undefined 'apikey' #9844

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

armin-x86
Copy link

This PR fixes a misleading error message in the codebase. Previously, the error message referenced "ApiKey", which could mislead users into thinking they need to use uppercase letters in their configuration. The error message now correctly references "apikey", aligning with the Fluent Bit documentation and actual configuration syntax.

N/A


Enter [N/A] in the box, if an item is not applicable to your change.

Testing
Before we can approve your change; please submit the following in a comment:

  • Example configuration file for the change:
    N/A (This change affects only the error message and does not introduce functional changes.)
  • Debug log output from testing the change:
    Log output after the change:
    [error] no apikey configuration key defined
  • Attached Valgrind output that shows no leaks or memory corruption was found:
    N/A (This change only updates a string in the error message.)

If this is a change to packaging of containers or native binaries then please confirm it works for all targets.

  • Run local packaging test showing all targets (including any new ones) build.
    N/A
  • Set ok-package-test label to test for all targets (requires maintainer to do).
    N/A

Documentation

  • Documentation required for this feature:
    N/A (This change does not require documentation updates.)

Backporting

  • Backport to latest stable release:
    N/A

Fluent Bit is licensed under Apache 2.0, by submitting this pull request I understand that this code will be released under the terms of that license.

@cosmo0920
Copy link
Contributor

This PR fixes a misleading error message in the codebase. Previously, the error message referenced "ApiKey", which could mislead users into thinking they need to use uppercase letters in their configuration. The error message now correctly references "apikey", aligning with the Fluent Bit documentation and actual configuration syntax.

Our configuration system is case-insensitive. So, it's not correct understandings. Using CamelCase in the error message is just for emphasizing the value of configuration key.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants