You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by "Nephery (via GitHub)" <gi...@apache.org> on 2024/02/07 17:18:32 UTC

[PR] Officially add Splunk HEC URL and token as query parameters [camel]

Nephery opened a new pull request, #13041:
URL: https://github.com/apache/camel/pull/13041

   # Description
   
   Make providing `splunkURL` and `token` through query parameters an officially documented feature of the Splunk HEC component.
   
   **Background**
   
   The current method (i.e. passing tokens via path parameters) leaks sensitive values into the logs, since Camel itself does not expect path parameters to contain sensitive info. This PR provides an alternative means of securely providing credentials to this component.
   
   **PR Change Specifics**
   
   * Marked `token` and `splunkURL` as query parameters.
   * Ensured that these properties are also validated when they're set through query parameters.
     * Prevented syntax validation of the `splunkURL` and/or `token` path parameters when their respective query parameters are already set.
   
   # Target
   
   - [ ] I checked that the commit is targeting the correct branch (note that Camel 3 uses `camel-3.x`, whereas Camel 4 uses the `main` branch)
   
   # Tracking
   - [ ] If this is a large change, bug fix, or code improvement, I checked there is a [JIRA issue](https://issues.apache.org/jira/browse/CAMEL) filed for the change (usually before you start working on it).
   
   <!--
   # *Note*: trivial changes like, typos, minor documentation fixes and other small items do not require a JIRA issue. In this case your pull request should address just this issue, without pulling in other changes.
   -->
   
   # Apache Camel coding standards and style
   
   - [ ] I checked that each commit in the pull request has a meaningful subject line and body.
   
   <!--
   If you're unsure, you can format the pull request title like `[CAMEL-XXX] Fixes bug in camel-file component`, where you replace `CAMEL-XXX` with the appropriate JIRA issue.
   -->
   
   - [ ] I have run `mvn clean install -DskipTests` locally and I have committed all auto-generated changes
   
   <!--
   You can run the aforementioned command in your module so that the build auto-formats your code. This will also be verified as part of the checks and your PR may be rejected if if there are uncommited changes after running `mvn clean install -DskipTests`.
   
   You can learn more about the contribution guidelines at https://github.com/apache/camel/blob/main/CONTRIBUTING.md
   -->
   
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Officially add Splunk HEC URL and token as query parameters [camel]

Posted by "oscerd (via GitHub)" <gi...@apache.org>.
oscerd commented on PR #13041:
URL: https://github.com/apache/camel/pull/13041#issuecomment-1932585072

   Camel is too big to follow semantic versioning. We usually allow breaking changes between minor versions. When we release an LTS all the patch releases will avoid breaking changes


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Officially add Splunk HEC URL and token as query parameters [camel]

Posted by "Nephery (via GitHub)" <gi...@apache.org>.
Nephery commented on PR #13041:
URL: https://github.com/apache/camel/pull/13041#issuecomment-1932587593

   Okay, sounds good. In that case, I'll update the PR to do what you suggested.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Officially add Splunk HEC URL and token as query parameters [camel]

Posted by "Nephery (via GitHub)" <gi...@apache.org>.
Nephery commented on PR #13041:
URL: https://github.com/apache/camel/pull/13041#issuecomment-1932581930

   @oscerd wouldn't that be breaking backwards compatibility for a minor version upgrade? Or is that okay in Camel?
   
   From a simplicity & code perspective, I agree that your suggestion would be a lot nicer.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Officially add Splunk HEC URL and token as query parameters [camel]

Posted by "davsclaus (via GitHub)" <gi...@apache.org>.
davsclaus merged PR #13041:
URL: https://github.com/apache/camel/pull/13041


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Officially add Splunk HEC URL and token as query parameters [camel]

Posted by "oscerd (via GitHub)" <gi...@apache.org>.
oscerd commented on PR #13041:
URL: https://github.com/apache/camel/pull/13041#issuecomment-1932829389

   LGTM, if you have time it would be nice to have an example of usage of the component in camel-examples, camel-spring-boot-examples or camel-quarkus-examples. Let's wait for more reviews :-)


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Officially add Splunk HEC URL and token as query parameters [camel]

Posted by "Nephery (via GitHub)" <gi...@apache.org>.
Nephery commented on PR #13041:
URL: https://github.com/apache/camel/pull/13041#issuecomment-1932801270

   > In my opinion it doesn't make sense to have both the parameters as path and query. I would leave just the url as path and add the token as mandatory query parameter. The proposed solution will confuse end user and since we are going to release 4.4.0 soon, I think we could remove the token as path parameter, add it only as mandatory query parameter and document it in the migration guide.
   
   I adjusted the PR according to @oscerd's proposal.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Officially add Splunk HEC URL and token as query parameters [camel]

Posted by "davsclaus (via GitHub)" <gi...@apache.org>.
davsclaus commented on PR #13041:
URL: https://github.com/apache/camel/pull/13041#issuecomment-1933572216

   @Nephery if you want to work more on splunk then we have this ticket
   https://issues.apache.org/jira/browse/CAMEL-20393


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Officially add Splunk HEC URL and token as query parameters [camel]

Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #13041:
URL: https://github.com/apache/camel/pull/13041#issuecomment-1932521517

   :star2: Thank you for your contribution to the Apache Camel project! :star2: 
   
   :robot: CI automation will test this PR automatically.
   
   :camel: Apache Camel Committers, please review the following items:
   
   * First-time contributors **require MANUAL approval** for the GitHub Actions to run
   
   * You can use the command `/component-test (camel-)component-name1 (camel-)component-name2..` to request a test from the test bot.
   
   * You can label PRs using `build-all`, `build-dependents`, `skip-tests` and `test-dependents` to fine-tune the checks executed by this PR.
   
   * Build and test logs are available in the Summary page. **Only** [Apache Camel committers](https://camel.apache.org/community/team/#committers) have access to the summary. 
   
   * :warning: Be careful when sharing logs. Review their contents before sharing them publicly.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org