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

Added documentation with examples to check NSM main events in logs #254

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

ljkiraly
Copy link

Signed-off-by: Laszlo Kiraly laszlo.kiraly@est.tech

Description

Troubleshooting description for checking some events in NSM logs.

Issue link

Checklist

  • Purpose
    • Bug fix
    • New functionality
    • Documentation
    • Refactoring
    • CI
  • Test
    • Unit test
    • E2E Test
    • Tested manually
  • Introduce a breaking change
    • Yes (description required)
    • No
  • Introduce changes in the Operator
    • Yes (description required)
    • No

@uablrek
Copy link
Contributor

uablrek commented Jul 22, 2022

Good addition to troubleshooting! IMHO precisely the kind of doc that should go in there. I could nitpick but I think contents is the important here (it should be easy to add things in the tr-guide) so I am ready to accept this PR with this constraint;

Drop the sub-directory. Have a flat structure will make it simpler to convert to other formats, e.g. wiki, and it is also more clear and easier to maintain unless the tr-guide grows too large. And in case of that unlikely even we can make a clean restructure when the day comes.

Copy link
Contributor

@uablrek uablrek left a comment

Choose a reason for hiding this comment

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

But drop the sub-dir

Signed-off-by: Laszlo Kiraly <laszlo.kiraly@est.tech>
@ljkiraly ljkiraly force-pushed the nsm-example-log-checking-doc branch from 201bc03 to bab15dd Compare July 22, 2022 08:10
@ljkiraly
Copy link
Author

Planning to add this description to NSM. Putting this on hold till decision.

@ljkiraly ljkiraly marked this pull request as draft July 22, 2022 08:12
@uablrek
Copy link
Contributor

uablrek commented Jul 22, 2022

Sounds good. NSM definitely needs more documentation. Please add a link in the Meridio ts-guide if you do.

@uablrek
Copy link
Contributor

uablrek commented Sep 7, 2022

When the NSM log issue is fixed, Meridio will format NSM logs in json (please see #275 (comment)). The way to analyze logs will be the same but the logs will look different.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 🏗 In progress
Development

Successfully merging this pull request may close these issues.

2 participants