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

Document use of logging.config JVM option. #1671

Closed
wants to merge 1 commit into from

Conversation

max8github
Copy link
Contributor

Option -Dlogging.config=src/main/resources/logback-dev-mode.xml was undocumented.

@github-actions github-actions bot added Documentation Improvements or additions to the documentation kalix-runtime Runtime and SDKs sub-team labels Jun 3, 2023
@@ -197,3 +197,19 @@ This time, `kalix:runAll` will start `docker-compose-integration.yml` instead. T
Note that the configuration is exactly the same except that now we are running one single `mvn kalix:runAll` command and the `docker-compose` file we are using contains all the dependencies required by *customer-registry-subscriber*.

This approach can be extended to any service you might want to integrate with. It can be any other Kalix service that you plan to deploy to the same Kalix project or even external services. The only requirement is to have a Docker image for it.

== Logging Settings when Running Locally
Copy link
Member

Choose a reason for hiding this comment

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

It's good to document it, but it is given the impression that you always need it. This is only needed when running Main.class directly from an IDE.

When running mvn kalix:run or mvn kalix:runAll (available since v1.2.1), you don't need to pass anything. It will configure the service to use logback-dev-mode.xml automatically.

That said, I think this part of the docs must be more explicitly about when running from the IDE.

@octonato
Copy link
Member

I'm closing this one because the need to document it will go away when we merge
#1719

Basically, when running inside the idea, we will pick logback-dev-mode.xml automatically.

@octonato octonato closed this Jul 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements or additions to the documentation kalix-runtime Runtime and SDKs sub-team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants