Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 logging architecture #2170
Document logging architecture #2170
Changes from 22 commits
65d3c02
89891e2
aa6839c
3afa04d
323347f
4e211e6
6bc6a6b
aae51ec
ba7c682
f10fd28
a9692fa
1298db6
c51f772
876c534
b05a82d
2c869d1
5e50bce
14f1457
f007ec6
91b1a46
c7b4f52
998b987
ee68f43
803ebaf
File filter
Filter by extension
Conversations
Jump to
There are no files selected for viewing
Check warning on line 16 in src/content/vintage/getting-started/observability/logging/_index.md
GitHub Actions / Front matter problems
Found 1 less severe problems
Check warning on line 21 in src/content/vintage/getting-started/observability/logging/architecture/index.md
GitHub Actions / Front matter problems
Found 1 less severe problems
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This doesn't tell the customer much why it's helpful for them. What are operational purposes? Does that mean they or only we can make use of it? I'd recommend shortening this intro, include customer-relevant points and only describe what's important to them. I assume that customers can make use of the MC Grafana instance (see existing article
How to access Grafana
which btw has a misspelled titleit's
/its
) and therefore we should strongly hint here why the architecture is important for customers (e.g. long-term storage, persistence, easy access via Grafana UI, ...) but not go into extensive detail or opinions ("the full Elastic stack is obviously out of the question").@pipo02mix I'm very unclear what was discussed around vintage docs. Shouldn't we start from scratch rather than editing existing docs? If so, we'd better revamp the whole thing and go through the "battle card" preparation before writing full articles. Since I'm unclear about this, I'd like to have it clarified first and will stop my review here for now.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I may be biased but operational purposes is quite straightforward to me. We need it to operate our platform and those 2 sentences have the same meanings.
I am not talking about the customer use yet here, only that they can access it via grafana.
Now, maybe the why we use Loki instead of Grafana could be somewhere else, I wrote this under the after some discussions with @carillan81 and @pipo02mix .
The goal of this doc is to show what we have and show our expertise but maybe the battlecard approach was missed.
Regarding the structure, I put this under vintage for now because of the full revamp being done and I have no issues moving it and refining the content later on with said battlecard, but in the mean time, I think this type of doc is useful and needs to be there. I could be wrong also but it's still better than having nothing at the moment at least
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agreed – I was writing my direct thoughts to challenge and make everyone think if everything still fits what we have here. We should check from scratch which pieces we put where, and if we can make it all shorter to increase chances of reading these articles. For example, does it fit into introductional, instructional or rather advanced parts of our docs, etc.?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm always happy with any feedback :)
Check warning on line 20 in src/content/vintage/getting-started/observability/logging/audit-logs/index.md
GitHub Actions / Front matter problems
Found 1 less severe problems
Check warning on line 21 in src/content/vintage/platform-overview/observability/_index.md
GitHub Actions / Front matter problems
Found 1 less severe problems