search

vert-x3 / vertx-stack

Vert.x stack
Apache License 2.0
120 stars 48 forks source link

Inconsistence Docs for Logging: Docker and Rest of Docs #79

Closed StephenOTT closed 11 months ago

StephenOTT commented 6 years ago

been going through the logging docs and there seems to be confusing inconsistencies between directions around logging for Docker deployments and the rest of the Vertx docs.

As a primary example: What is the reason for the docker docs to use logging.properties as the file: http://vertx.io/docs/vertx-docker/#_logging along with ENV vars, but the rest of the docs all use vertx-default-jul-logging.properties as their examples:

Hazelcast: http://vertx.io/docs/vertx-hazelcast/java/#_enabling_logging Core: http://vertx.io/docs/vertx-core/js/#_logging From core:

A JUL logging configuration file can be specified in the normal JUL way by providing a system property called: java.util.logging.config.file with the value being your configuration file. For more information on this and the structure of a JUL config file please consult the JUL logging documentation.

Vert.x also provides a slightly more convenient way to specify a configuration file without having to set a system property. Just provide a JUL config file with the name vertx-default-jul-logging.properties on your classpath (e.g. inside your fatjar) and Vert.x will use that to configure JUL.

Happy to do a PR to update docs. Just want to get direction around the usage and history.

tsegismont commented 6 years ago

@StephenOTT the vertx-default-jul-logging.properties file is just a convenient way to configure JUL when you're able to add something to the classpath. You could have a logging.properties file anywhere on the FS and use it together with the java.util.logging.config.file sysprop.

In the vertx-docker example however, we're talking about applications started with the Vert.x CLI. In this case, the user may either configure the conf/logging.properties CLI file or set the VERTX_JUL_CONFIG env var.

StephenOTT commented 6 years ago

the user may either configure the conf/logging.properties

Is there a folder structure documentation of vertx projects? I dont come from a java dev background. So looking for where the defaulted folders and use cases are. I have seen /conf/ used in a few examples, but no documentation about when it is being used.

tsegismont commented 6 years ago

@StephenOTT /conf here is not a project directory but a directory in the CLI installatio

@cescoffier do we have documentation for CLI layout and stack update? I couldn't find it in vertx-core doc

cescoffier commented 6 years ago

@tsegismont I don't think we have this documented. We more or less inherited this from Vert.x 2.

tsegismont commented 6 years ago

@cescoffier so a PR to core doc would be best, correct?

cescoffier commented 6 years ago

@tsegismont yes.

cescoffier commented 6 years ago

@tsegismont actually, it may be better to document it in the stack manager manual (https://github.com/vert-x3/vertx-stack/blob/master/stack-manager/src/main/java/io/vertx/stack/command/package-info.java). The manual does not provide any details about the structure, I believe it should live there. But at the same time the vert.x core doc contains the doc for the vertx cli.

StephenOTT commented 6 years ago

@tsegismont @cescoffier so what can go into /conf?

/conf if a pattern used in other java projects, correct?

tsegismont commented 6 years ago

@StephenOTT in conf I think we only have logging and stack config files IIRC.

Not sure what you mean by "pattern". It's just a directory for configuration files in a tool installation. I don't believe this is specific to Java.

tsegismont commented 11 months ago

Closing, Docker images are no longer provided anyway