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

Add additional details about log structure #261

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

LucasRoesler
Copy link
Member

What

  • Add details explaining where the values in the log lines come from.
    Identifying the parts that are metadata from the log provider and the
    parts that are the actual log message.

Motivation and Context

  • I have raised an issue to propose this change (required)

Follow-up to 258

How Has This Been Tested?

Viewed the rendered pages using Docker

docker run --rm -it -p 8000:8000 -v `pwd`:/docs squidfunk/mkdocs-material

for example

image

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I've read the CONTRIBUTION guide
  • I have signed-off my commits with git commit -s

**What**
- Add details explaining where the values in the log lines come from.
  Identifying the parts that are metadata from the log provider and the
  parts that are the actual log message.

Signed-off-by: Lucas Roesler <roesler.lucas@gmail.com>
docs/cli/logs.md Outdated
@@ -28,13 +28,19 @@ The logs for a function will look
<RCF8601 Timestamp> <function name> (<container instance>) <msg>
```

where `msg` is the container logs, this typically contains stdout and stderr of the _contianer_.
where `msg` is the container logs, this typically contains stdout and stderr of the _contianer_. The values of `<RCF8601 Timestamp>`, `<function name>`, `<container instance>` come from the log provider (by default this is the orchestration systems: kubeneretes log API or journalctl).
Copy link
Member

Choose a reason for hiding this comment

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

_contianer_ <- container (typo)

Copy link
Member

Choose a reason for hiding this comment

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

kubeneretes (typo)

Copy link
Member Author

Choose a reason for hiding this comment

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

fixed

Signed-off-by: Lucas Roesler <roesler.lucas@gmail.com>
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.

2 participants