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

services/horizon: Add more verbose logging for horizon start up #4161

Merged
merged 2 commits into from
Jan 6, 2022

Conversation

erika-sdf
Copy link
Contributor

@erika-sdf erika-sdf commented Jan 4, 2022

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

Add more verbose logging to horizon start up. Include lines that signal db migration and captive core set up, which should be logged to stdout since it happens before logging is set up.

Why

It would make debugging easier.

Known limitations

@erika-sdf erika-sdf linked an issue Jan 4, 2022 that may be closed by this pull request
@erika-sdf erika-sdf changed the title Logs services/horizon: Add more verbose logging for horizon start up Jan 4, 2022
@erika-sdf erika-sdf marked this pull request as ready for review January 5, 2022 00:50
@erika-sdf erika-sdf requested review from a team and jacekn January 5, 2022 01:42
Copy link
Contributor

@jacekn jacekn left a comment

Choose a reason for hiding this comment

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

Thank you, it's a very nice improvement. It looks good to me but it would be good to get 2nd review from somebody with more go experience.

@@ -509,6 +509,8 @@ func NewAppFromFlags(config *Config, flags support.ConfigOptions) (*App, error)
if config.Ingest && !config.EnableCaptiveCoreIngestion && config.StellarCoreDatabaseURL == "" {
return nil, fmt.Errorf("flag --%s cannot be empty", StellarCoreDBURLFlagName)
}

log.Infof("Initializing horizon...")
Copy link
Contributor

Choose a reason for hiding this comment

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

does this output print on console, wasn't sure on significance of using this or stdLog, the desired outcome is to be on console correct, assume they both output there, was just asking for my own edification on logging preferences.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Both log and stdLog calls print to console. The code that runs prior to the logger initialization uses the stdLog calls. I think @jacekn 's feature request was specifically about seeing failures prior to the initialization, so the stdLog statements provide some context on what's happening.

@erika-sdf erika-sdf merged commit 3f6217e into stellar:master Jan 6, 2022
@@ -18,6 +18,7 @@ import (
)

func mustNewDBSession(subservice db.Subservice, databaseURL string, maxIdle, maxOpen int, registry *prometheus.Registry) db.SessionInterface {
log.Infof("Establishing database session at %s for %v", databaseURL, subservice)
Copy link
Contributor

Choose a reason for hiding this comment

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

Sorry for a late review. I was OOO. Not sure if we should print databaseURL as it contains a sensitive info (password).

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.

Feature Request: more verbose logging during horizon startup
4 participants