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.

Sign up for GitHub

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

Jump to bottom

Documentation for Observability Kit #1697

Merged
merged 86 commits into from
Oct 4, 2022
Merged

Documentation for Observability Kit #1697

merged 86 commits into from
Oct 4, 2022

Conversation

MatthewVaadin
Copy link
Contributor

@MatthewVaadin MatthewVaadin commented Sep 8, 2022 •
edited
Loading

The Observability Kit documentation. Contains an overview, a quick-start tutorial, integration guidelines and some advanced topics.

@github-actions github-actions bot added the Language unchecked English language check has not been done label Sep 8, 2022
@caalador caalador marked this pull request as draft September 8, 2022 12:03
caalador
caalador reviewed Sep 9, 2022
View reviewed changes
articles/tools/observability/advanced/observability-agent.asciidoc Outdated Show resolved Hide resolved
articles/tools/observability/advanced/observability-agent.asciidoc Outdated Show resolved Hide resolved
articles/tools/observability/advanced/observability-agent.asciidoc Outdated Show resolved Hide resolved
articles/tools/observability/overview.asciidoc Outdated Show resolved Hide resolved
articles/tools/observability/overview.asciidoc Outdated Show resolved Hide resolved
articles/tools/observability/tutorial/getting-started.asciidoc Outdated Show resolved Hide resolved
articles/tools/observability/advanced/observability-agent.asciidoc Outdated Show resolved Hide resolved
articles/tools/observability/tutorial/newrelic.asciidoc Outdated Show resolved Hide resolved
articles/tools/observability/tutorial/jaeger-prometheus.asciidoc Outdated Show resolved Hide resolved
@caalador @MatthewVaadin
add custom instrumentation doc (#1701)
11ef47a 
* add custom instrumentation doc

* Big API

* Add attribute, event and error info to the doc

* Update articles/tools/observability/advanced/custom-instrumentation.asciidoc

Co-authored-by: MatthewVaadin <98319962+MatthewVaadin@users.noreply.github.com>

Co-authored-by: MatthewVaadin <98319962+MatthewVaadin@users.noreply.github.com>
@jouni jouni mentioned this pull request Sep 12, 2022
Merged
@MatthewVaadin MatthewVaadin added Language unchecked English language check has not been done and removed Language unchecked English language check has not been done labels Sep 12, 2022
@sissbruecker sissbruecker mentioned this pull request Sep 12, 2022
Merged
sissbruecker and others added 5 commits September 12, 2022 13:24
@sissbruecker
docs: improve observability overview (#1704)
9b5025d
@caalador @MatthewVaadin
feat: start Integrations main page (#1705)
3aca636 
* feat: start Integrations main page

Start the introduction page for
integrations documentation

* Apply suggestions from code review

Co-authored-by: MatthewVaadin <98319962+MatthewVaadin@users.noreply.github.com>

Co-authored-by: MatthewVaadin <98319962+MatthewVaadin@users.noreply.github.com>
@sissbruecker @caalador @MatthewVaadin
docs: improve custom instrumentation docs (#1702)
4ae357b 
* docs: improve custom instrumentation docs

* add missing note

* Apply suggestions from code review

Co-authored-by: caalador <mikael.grankvist@vaadin.com>
Co-authored-by: MatthewVaadin <98319962+MatthewVaadin@users.noreply.github.com>

* add hotspots to vocab

* Update .github/styles/Vocab/Docs/accept.txt

Co-authored-by: MatthewVaadin <98319962+MatthewVaadin@users.noreply.github.com>

Co-authored-by: caalador <mikael.grankvist@vaadin.com>
Co-authored-by: MatthewVaadin <98319962+MatthewVaadin@users.noreply.github.com>
@caalador
fix: add missing annotations dependency (#1708)
8e168e9 
The instrumentation-annotation was mistakenly
dropped during refactoring. Re add  required
dependencies to correct parts of the document.
@MatthewVaadin
Add running instructions
c4f7d19
@aws-amplify-eu-west-1
Copy link

This pull request is automatically being deployed by Amplify Hosting (learn more).

Access this pull request here: https://pr-1697.dcmp4ajsd49kq.amplifyapp.com

sissbruecker and others added 6 commits September 13, 2022 11:05
@sissbruecker
docs: add Grafana integration (#1706)
df1b4cc 
Add instructions for Grafana
@caalador
Move integrations info to index (#1709)
abe41fc 
Update running in jaeger and newrelic
to use the grafana _run-app documentation
@caalador
feat: add custom metrics documentation (#1710)
93114bf 
* feat: add custom metrics documentation

* Finish sentence
@MatthewVaadin
Refactor document sections
23bb389
@MatthewVaadin
Merge remote-tracking branch 'origin/feat/observability' into feat/ob…
11c5d5c 
…servability

# Conflicts:
#	articles/tools/observability/integrations/jaeger-prometheus.asciidoc
#	articles/tools/observability/integrations/newrelic.asciidoc
@MatthewVaadin
Rename Vaadin Observability to Observability Kit and add icon
d844293
jouni and others added 20 commits October 3, 2022 13:48
@jouni
update main description
7828bb2
@jouni
convert table into description list
7ce0385
@jouni
remove unnecessary “next page” link
cf279b9
@jouni
fix main heading level
3e496d6
@jouni
don't force links to open in a new tab
af792ee
@jouni
improve description, reduce heading nesting
2de4df6
@jouni
Quick Start Tutorial → Getting Started
120af36
@jouni
avoid “the Observability Kit agent”
01b9efd
@jouni
accept UI as a term/word
3b55cef
@MatthewVaadin
Make the download link more prominent and available in more pages
c5afb3d
@jouni
don't nag about “address”
d6016cc
@jouni
suggest "drop-down” instead of “overlay”
a5f1f2d
@jouni
avoid duplicate suggestions
c1eb6ec
@jouni
accept API as a word/term
bbe8ef1
@jouni
don't wrap guilabels or guibuttons
8c4e6d7
@jouni
minor restructure plus lots of editing
9e98d17 
Remove the “Advanced” sub-section.

Combine "using traces” and “observability kit agent” pages into “reference”.

Combine “custom instrumentation” and the “creating custom metrics” sub-section from ”metrics” into “customization”.
@jouni
Merge branch 'feat/observability' of https://github.com/vaadin/docs i…
a6dc4d2 
…nto feat/observability
@jouni
cleanup merge updates
4199e00
@jouni
more editing and cleanup
18fb2eb 
consistency within the integrations pages
@jouni
Add prominent download button to the index page
8f50766
@jouni
Copy link
Member

jouni commented Oct 4, 2022

I did quite a bit of editing (overall structure and page-level details). I assume I managed to keep all facts straight, but hopefully made the content easier to digest.

@MatthewVaadin, I’m not sure what triggered your latest change (the download button on all integration pages). I removed it, and added that button on the main index page for now. Let me know if this was something that came up in DX tests, that users were struggling to find where to download the JAR, and if you think my solution is a sufficient fix.

@jouni
Copy link
Member

jouni commented Oct 4, 2022

I’m merging this now, and we can address further issues with additional PRs.

@jouni jouni merged commit e4f9a89 into latest Oct 4, 2022
@jouni jouni deleted the feat/observability branch October 4, 2022 09:18
@jouni
Copy link
Member

jouni commented Oct 4, 2022

Ah, I forgot to clean up the Customization article. I’ll do that now.

@MatthewVaadin
Copy link
Contributor Author

@jouni
Yes, we had feedback from all of the DX tests that said it was difficult to find the download link.
I think it's fine to just have it on the index page and the quick start tutorial.

I did also change the order of the sections in the tutorial as I feel it makes more sense to obtain O11y Kit before setting up other software.

@jouni
Copy link
Member

jouni commented Oct 4, 2022 •
edited
Loading

I did also change the order of the sections in the tutorial as I feel it makes more sense to obtain O11y Kit before setting up other software.

Oh, right, I noticed that and then forgot about it during the merge. I can switch that back like you had it. Done in 49264e7

@heruan heruan mentioned this pull request Feb 21, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sissbruecker sissbruecker sissbruecker left review comments

@jouni jouni jouni approved these changes

@caalador caalador caalador approved these changes

@russelljtdyer russelljtdyer russelljtdyer approved these changes

Assignees

@jouni jouni

@russelljtdyer russelljtdyer

Labels
Language checked English language check done
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@MatthewVaadin @caalador @CLAassistant @jouni @sissbruecker @russelljtdyer