feat: opt-in to expose successful connection logs #123
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This changes removes the addition of the eventPayload key that was imposed in the previous commit. I would rather leave the decision to the maintainers. Whether it be reverting *this* commit, or accepting this one, or leaving it to the future PR.
This change adds a configuration option for users to expose successful connection logs. This is controlled via an environment variable that, when set to true, will produce the successful connection log as an `info` level message, rather than a `debug` level message. Exposing these logs can be useful for calculating SLIs. SLIs are the quotient of errors over valid requests, therefore all valid messages need to be surfaced to perform an accurate calculation of the metric.
therealvio
commented
Jan 16, 2025
| @@ -5,6 +5,7 @@ locals { | |||
| : replace(upper(obj.az), "-", "_") => join(",", obj.route_table_ids) | |||
| } | |||
| has_ipv6_env_var = { "HAS_IPV6" = var.lambda_has_ipv6 } | |||
| log_successful_connections_env_var = { "LOG_SUCCESSFUL_CONNECTIONS" = var.log_successful_connections } | |||
There was a problem hiding this comment.
I am not incredibly versed in base Terraform, being a CDKTF user myself. I am looking to make sure I am adding this variable right. Any and all feedback on how to achieve this is welcome!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Purpose 🎯
This change adds a configuration option for users to expose successful connection logs. This is controlled via an environment variable that, when set to true, will produce the successful connection log as an
infolevel message, rather than adebuglevel message.Exposing these logs can be useful for calculating SLIs. SLIs are the quotient of errors over valid requests, therefore all valid messages need to be surfaced to perform an accurate calculation of the metric.
Context 🧠
Note
#122 should be finalised, and merged before this PR comes in since it is based off of the changes it includes.