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

sevices/friendbot: Allow friendbot to include cloudflare derived IP address in request logs #5359

Merged
merged 5 commits into from
Jun 28, 2024

Conversation

tamirms
Copy link
Contributor

@tamirms tamirms commented Jun 26, 2024

PR Checklist

PR Structure

  • This PR has reasonably narrow scope (if not, break it down into smaller PRs).
  • This PR avoids mixing refactoring changes with feature changes (split into two PRs
    otherwise).
  • This PR's title starts with name of package that is most changed in the PR, ex.
    services/friendbot, or all or doc if the changes are broad or impact many
    packages.

Thoroughness

  • This PR adds tests for the most critical parts of the new functionality or fixes.
  • I've updated any docs (developer docs, .md
    files, etc... affected by this change). Take a look in the docs folder for a given service,
    like this one.

Release planning

  • I've updated the relevant CHANGELOG (here for Horizon) if
    needed with deprecations, added features, breaking changes, and DB schema changes.
  • I've decided if this PR requires a new major/minor version according to
    semver, or if it's mainly a patch change. The PR is targeted at the next
    release branch if it's not a patch change.

What

Friendbot uses a logging middleware which is used to log incoming requests. Those logs include the client's IP address. However, that ip address is incorrect if the friendbot http server is load balanced by cloudflare. This PR implements a configuration option which enables friendbot to include the real client ip derived from cloudflare in the request logs.

Why

It is useful to see real ips in the logs so we can see observe traffic patterns

Known limitations

[N/A]

@tamirms tamirms requested review from jacekn and a team June 26, 2024 13:00
Copy link
Contributor

@sreuland sreuland left a comment

Choose a reason for hiding this comment

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

are there any integration tests in the repo that bring up friendbot to confirm this config change works?

@tamirms
Copy link
Contributor Author

tamirms commented Jun 27, 2024

@sreuland I added a unit test. Does that look good to you?

@tamirms tamirms enabled auto-merge (squash) June 28, 2024 05:11
@tamirms tamirms merged commit 01dc176 into stellar:master Jun 28, 2024
15 of 23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants