Skip to content

Example log output is out-of-date and inconsistent #28208

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

Closed
wilkinsona opened this issue Oct 6, 2021 · 5 comments
Closed

Example log output is out-of-date and inconsistent #28208

wilkinsona opened this issue Oct 6, 2021 · 5 comments
Assignees
Labels
type: documentation A documentation update
Milestone

Comments

@wilkinsona
Copy link
Member

https://docs.spring.io/spring-boot/docs/2.4.x/reference/htmlsingle/#boot-features-spring-application

  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::   v2.4.11

2019-04-31 13:09:54.117  INFO 56603 --- [           main] o.s.b.s.app.SampleApplication            : Starting SampleApplication v0.1.0 on mycomputer with PID 56603 (/apps/myapp.jar started by pwebb)
2019-04-31 13:09:54.166  INFO 56603 --- [           main] ationConfigServletWebServerApplicationContext : Refreshing org.springframework.boot.web.servlet.context.AnnotationConfigServletWebServerApplicationContext@6e5a8246: startup date [Wed Jul 31 00:08:16 PDT 2013]; root of context hierarchy
2019-04-01 13:09:56.912  INFO 41370 --- [           main] .t.TomcatServletWebServerFactory : Server initialized with port: 8080
2019-04-01 13:09:57.501  INFO 41370 --- [           main] o.s.b.s.app.SampleApplication            : Started SampleApplication in 2.992 seconds (JVM running for 3.658)

As we've updated the example over the years, things have become a bit inconsistent:

  • The PID isn't the same in all the log lines
  • The date goes backwards
  • The logged startup date doesn't match the date at the start of the line

I wonder if we could automate capturing the example output to avoid the problem reoccurring.

@wilkinsona wilkinsona added this to the 2.4.x milestone Oct 6, 2021
@wilkinsona wilkinsona added the type: documentation A documentation update label Oct 6, 2021
@philwebb
Copy link
Member

philwebb commented Oct 6, 2021

+1 to automating it, although I’d ideally like to have consistent dates and startup time values.

@philwebb
Copy link
Member

philwebb commented Oct 6, 2021

Given all the doc updates, I’d also be tempted to do this only in 2.5.x or 2.6.x

@snicoll
Copy link
Member

snicoll commented Oct 7, 2021

Perhaps doing it manually in 2.4.x then?

@philwebb philwebb modified the milestones: 2.4.x, 2.5.x Oct 7, 2021
@wilkinsona wilkinsona added the for: team-meeting An issue we'd like to discuss as a team to make progress label Oct 8, 2021
@philwebb philwebb modified the milestones: 2.5.x, 2.4.x Oct 13, 2021
@philwebb
Copy link
Member

Given all the doc updates, I’d also be tempted to do this only in 2.5.x or 2.6.x

Thinking some more, the merge probably won't be that painful so lets aim for 2.4.x

@philwebb philwebb removed the for: team-meeting An issue we'd like to discuss as a team to make progress label Oct 13, 2021
@wilkinsona wilkinsona modified the milestones: 2.4.x, 2.5.x Nov 18, 2021
@wilkinsona wilkinsona modified the milestones: 2.5.x, 2.6.x May 19, 2022
@wilkinsona wilkinsona self-assigned this Aug 4, 2022
@wilkinsona wilkinsona changed the title Example SpringApplication log output is inconsistent Example log output is out-of-date and inconsistent Aug 4, 2022
@wilkinsona
Copy link
Member Author

This has got a bit worse in the 3.0 docs since we changed the date format. I'd like to fix this in all branches so that we don't have to remember to update things manually any more.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation A documentation update
Projects
None yet
Development

No branches or pull requests

3 participants