Skip to content

Conversation

Tanzp01
Copy link
Contributor

@Tanzp01 Tanzp01 commented Sep 30, 2025

Added 2 structured loggings for:

  1. dns lookup latency with timestamp
  2. dns error with timestamp

What type of PR is this?

/kind feature

What this PR does / why we need it:

To better analyse the performance of DNS over time

Special notes for your reviewer:

There were existing loggings, but not structured. I added these 2 opt-in structured logging while keeping the previous loggings, so that any existing analysis based on the logging won't be affected

@k8s-ci-robot k8s-ci-robot added kind/feature Categorizes issue or PR as related to a new feature. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Sep 30, 2025
@k8s-ci-robot
Copy link
Contributor

Hi @Tanzp01. Thanks for your PR.

I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Sep 30, 2025
@Tanzp01
Copy link
Contributor Author

Tanzp01 commented Sep 30, 2025

cc @bowei the owner of this directory

log.Printf("DNS lookup of name %q, err - %v\n", name, err)
}
if err != nil {
log.Printf("Failed DNS lookup of name %q, err - %v\n", name, err)
Copy link

Choose a reason for hiding this comment

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

This log message is duplicated by structured errorLogger. Maybe structured errorLogger should always be enabled and replace the existing log message? I don't know if this is common for any automation to traverse these logs and changing log message can lead to some failures.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks, I have enabled the errorLogger by default and remove the old log.

@bowei
Copy link
Member

bowei commented Oct 6, 2025

/assign @bowei

@bowei
Copy link
Member

bowei commented Oct 6, 2025

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Oct 6, 2025
@Tanzp01 Tanzp01 force-pushed the add_timestamp_for_dnsperfgo branch from d09cd73 to 65b188b Compare October 7, 2025 13:09
@jprzychodzen
Copy link
Contributor

/lgtm

/assign @tosi3k

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 7, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: jprzychodzen, marqc, Tanzp01
Once this PR has been reviewed and has the lgtm label, please assign dlapcevic for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Copy link
Member

@bowei bowei left a comment

Choose a reason for hiding this comment

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

Unrelated comment:

  • There is what looks like abandoned code in comments at the bottom -- I would send another PR to delete it.
  • The timedOut variable looks weird to me but don't fix it in this change.

startTime := time.Now()
_, err := lookupFunc(name)
latency := time.Since(startTime)
if infoLogger != nil && err == nil {
Copy link
Member

Choose a reason for hiding this comment

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

why not route the infoLogger to a dummy logger that doesn't output instead of having if statements?

Copy link
Member

Choose a reason for hiding this comment

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

I also recommend logging for all lookups, irrespective of err == nil or not.

_, err := lookupFunc(name)
latency := time.Since(startTime)
if infoLogger != nil && err == nil {
infoLogger.Info("DNS lookup successful, latency recorded",
Copy link
Member

Choose a reason for hiding this comment

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

suggest:

infoLogger("lookup", "name", name, "latency_ms", latency.Milliseconds(), "err", err)

Latency we want in milliseconds
Record the error.

log.Printf("Failed DNS lookup of name %q, err - %v\n", name, err)
errorLogger.Error("Failed DNS lookup",
"hostname", name,
"error", err.Error(),
Copy link
Member

Choose a reason for hiding this comment

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

Do you need to call Error? Isn't it extraneous?

if err != nil {
log.Printf("Failed DNS lookup of name %q, err - %v\n", name, err)
errorLogger.Error("Failed DNS lookup",
"hostname", name,
Copy link
Member

Choose a reason for hiding this comment

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

make it easier to maintain -- "name", name

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/feature Categorizes issue or PR as related to a new feature. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants