Troubleshooting and Reference pages do not reference multi-app-dapr-run

Open Beginner friendly
#4,444 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Domain
documentation

Research direction

Read the troubleshooting logs page and the arguments/annotations overview linked in the issue, then compare their dapr run guidance with the multi-app template page. Update both pages to explain that multi-app dapr run configurations differ and link readers to the multi-app documentation; done means users can find the applicable logging instructions from either page.

Written by the indexing model from the issue text.

Description

content/incorrect-information

Describe the issue
I was trying out the quickstart sample at https://github.com/dapr/quickstarts/tree/master/pub_sub/java/sdk and I was trying to get more logging from the dapr runtime (daprd).

I searched for how to control the log levels and Auntie Google directed me to (1) and (2).

I tried applying the instructions on (1) and (2) with dapr run --log-level debug -f . It didn't work - the applied log levels didn't change (the fact that it didn't work is not the issue that I am reporting).

After looking some more, I discovered (3). When I applied the instructions in (3) I got the logging that I wanted.

My issue is that (1) and (2) are phrased in such a way as to indicate (at least to me) that they describe a way that works for all dapr run commands and that no other configuration is required.

URL of the docs

  1. https://docs.dapr.io/operations/troubleshooting/logs-troubleshooting/
  2. https://docs.dapr.io/reference/arguments-annotations-overview/
  3. https://docs.dapr.io/developing-applications/local-development/multi-app-dapr-run/multi-app-template/

Expected content
I suggest that the content of (1) and (2) be changed to indicate that dapr run with multi-app configuration (so -f ?) is configured differently and that some of the information provided on (1) and (2) is not applicable to running dapr run -f and that the user be directed to, or at least provided with a link to, (3).

Screenshots
N/A

Additional context
IMHO, While the README.md for the quickstart does reference (3), I think (1) and (2) should also reference it.

Dominant language
SCSS
Stars
1k
Forks
796
Avg merge
3d 12h
Merged PRs (30d)
16

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from dapr/docs

All issues in dapr/docs

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.