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
Update the integration page to reflect new integration catalog features #7324
Update the integration page to reflect new integration catalog features #7324
Changes from 1 commit
93516cf
2615a67
49c42c0
f311e7d
cfcec50
1cfd6ff
272d5ee
c78a878
569da98
8879cd1
6ad6c33
569fc94
785ad27
b14f430
0f1edd9
fe96327
454eaf6
d6b7578
063300e
da691ae
ad584de
546df12
08a6f65
52d44a5
a02b9ce
299e34e
217d3a9
8857415
7f867d5
ad8da8c
7ac1d84
fb62391
da4a7ba
dd09883
3487063
00963f3
6be61b4
bc51f08
0a84371
0968065
aec912b
7e15223
91d7322
2ccbb68
04f416b
2d5340e
bfcd535
fa3239f
b3d2e4f
d040f9e
d90a7c7
00638a6
11de5f6
d8dab6b
7852e3a
1d89a46
65e60c0
846eac9
aa6b6a3
22dac2b
e69848c
ad9e2dd
adb1d47
d96441c
37a6034
47e652f
c813e75
29d5d37
f765189
e29380e
5fb500e
4ad8159
48ea732
1645420
6b11b59
fda846d
4fae073
784b476
91b4106
9a7bed6
e496e9d
f602b5b
9871ac7
5989e6f
0d67707
39c6a4b
d10a9c2
c321bf3
4116cc5
92bea17
1869cb2
0d4ae92
ab91f66
8bbabbe
f745177
a2f4963
0ec77b8
cd6ae7a
9882b16
6559ff0
e36429a
e428009
d013595
9808726
f96293e
b06545a
210c2df
83f04fc
be2b6cb
64cb7ac
58eee30
86879ef
7f84cc0
594ddd2
d82658c
523074b
e7e7af8
e457b27
eff1acd
736143c
1d08fa5
723a285
7d8c583
55ffab8
File filter
Filter by extension
Conversations
Jump to
There are no files selected for viewing
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.
Naming this "OpenSearch Integrations", and especially using "Integrations" on its own, is ambiguous and will create capitalization and reference (are we referring to the feature or to the generic concept of integrations?) issues in this and future documentation.
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.
@natebower Integrations is the proper name. Do you have suggestions on how I use the proper name? I'm thinking I should bold the instances where we're referring to the application. Generic usage should be lowercase, unless of course it starts a sentence. I'll revise this doc.
Check failure on line 20 in _integrations/index.md
GitHub Actions / style-job
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 not sure these steps make sense as written -- ingestion is left out, and many users create visualizations within the dashboard directly instead of doing it separately. We still expect a matching mapping in the new system. In practice I think it's closer to
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.
Why do we bold Integration framework throughout the doc? I'm not sure we're using it as a technical term, I would replace almost all occurrences of "The Integration framework" with "[OpenSearch] Integrations".
Check failure on line 34 in _integrations/index.md
GitHub Actions / style-job
Check failure on line 37 in _integrations/index.md
GitHub Actions / style-job
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.
"Out of the box" we have observability today (and security WIP), the other domains are still open for community extension
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.
OCSF schema support is only a few days away...
Check failure on line 42 in _integrations/index.md
GitHub Actions / style-job
Check failure on line 43 in _integrations/index.md
GitHub Actions / style-job
Check failure on line 46 in _integrations/index.md
GitHub Actions / style-job
Check failure on line 48 in _integrations/index.md
GitHub Actions / style-job
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 think this section could do with more elaboration on why selecting a schema is significant and why we chose to unify integrations around a shared schema. This idea isn't common to many other integration products, so users may be coming in cold on this.
Maybe start from domains and explain how the schema helps users understand their domains. For example: what's a specific concept in OTEL that you would not typically have in a generic logging solution, that helps to solve real observability problems? How?
Check failure on line 53 in _integrations/index.md
GitHub Actions / style-job
Check failure on line 58 in _integrations/index.md
GitHub Actions / style-job
Check warning on line 67 in _integrations/index.md
GitHub Actions / style-job
Check warning on line 68 in _integrations/index.md
GitHub Actions / style-job
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 might be wrong, but do you think we need a link for the releases in catalog repo?
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.
Since we ship with a default catalog, this state will never be visible
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.
the integrations are not "installed" by default but rather the integration template are - we need to agree on the terminology here...
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 image should be referenced in the preceding text.
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 think we should go through a real setup example instead of the sample data flow, since "Try it" is one click. It's more writing but it will pay off to show real usage. We can maybe use the otel-demo repo?
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.
agree but it will to too long here - probably best to create a separate page for this purpose
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.
Alternatively, you can add an expandable setup example by enclosing it in the details block. This helps avoid the too-long issue.
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.
@YANG-DB This image differs from what I see in the nightly playground. Please let me know if I should update this image.
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.
keep the image - its up to date
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.
Check warning on line 133 in _integrations/index.md
GitHub Actions / style-job
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.
Is this mean to be empty?
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.
We should advise users to use "Check for existing objects" + "Auto overwrite", because we ship the integrations with a specific UUID based on the integration+version to help keep duplicates down. Uploading the same integration template multiple times isn't that useful.