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

all: document valid initial interval units. #6706

Merged
merged 1 commit into from Jul 7, 2023
Merged

all: document valid initial interval units. #6706

merged 1 commit into from Jul 7, 2023

Conversation

efd6
Copy link
Contributor

@efd6 efd6 commented Jun 27, 2023

What does this PR do?

Add note in manifests of akamai, atlassian_bitbucket, atlassian_confluence, atlassian_jira, cisco_secure_endpoint, cloudflare, forgerock, github, m365_defender, microsoft_exchange_online_message_trace, okta, panw_cortex_xdr, slack, ti_cybersixgill, ti_misp, tines, zerofox and zeronetworks to show valid initial interval units where not already specified.

Not all acceptable units are listed, but rather choose commonly used units that are already documented in other packages.

Checklist

  • I have reviewed tips for building integrations and this pull request is aligned with them.
  • I have verified that all data streams collect metrics or logs.
  • I have added an entry to my package's changelog.yml file.
  • I have verified that Kibana version constraints are current according to guidelines.

Author's Checklist

  • [ ]

How to test this PR locally

Related issues

Screenshots

@efd6 efd6 self-assigned this Jun 27, 2023
@elasticmachine
Copy link

elasticmachine commented Jun 27, 2023 •
edited

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Start Time: 2023-07-06T03:36:43.042+0000

  • Duration: 23 min 59 sec

Test stats 🧪

Test Results
Failed 0
Passed 412
Skipped 0
Total 412

🤖 GitHub comments

Expand to view the GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

@elasticmachine
Copy link

elasticmachine commented Jun 27, 2023 •
edited

🌐 Coverage report

Name Metrics % (covered/total) Diff
Packages 100.0% (58/58) 💚
Files 100.0% (67/67) 💚
Classes 100.0% (67/67) 💚
Methods 96.265% (799/830) 👍 1.854
Lines 91.052% (17320/19022) 👎 -1.675
Conditionals 100.0% (0/0) 💚

@efd6 efd6 marked this pull request as ready for review June 27, 2023 01:43
@efd6 efd6 requested a review from a team as a code owner June 27, 2023 01:43
@elasticmachine
Copy link

Pinging @elastic/security-external-integrations (Team:Security-External Integrations)

andrewkroh
andrewkroh reviewed Jun 27, 2023
View reviewed changes
Copy link
Member

@andrewkroh andrewkroh left a comment

Choose a reason for hiding this comment

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

  1. Should this be extended to cover interval too?
  2. Can you please post a screenshot of one of the text fields with the description. I'm debating on whether the NOTE: is too strong visually vs having s/NOTE: S/The s/g. I thinking that if it will appear on more than one field that the non-"NOTE" version might be better.

@efd6
Copy link
Contributor Author

efd6 commented Jun 27, 2023

I'll add the interval too.

For the formatting, the text here is taken from an existing integration (I don't recall which). In the wild, there are two dominant forms, the one here and one "NOTE:- Supported units for this parameter are h/m/s."

@efd6
all: document valid interval duration units.
e8a03b7 
Not all acceptable units are listed, but rather choose commonly used units that
are already documented in other packages.

akamai, atlassian_bitbucket, atlassian_confluence, atlassian_jira, bitdefender,
box_events, cisco_secure_endpoint, cloudflare, cloudflare, forgerock, github,
github, jumpcloud, m365_defender, microsoft_defender_endpoint,
microsoft_exchange_online_message_trace, mimecast, okta, panw_cortex_xdr, slack,
ti_abusech, ti_cif3, ti_cybersixgill, ti_cybersixgill, ti_misp, ti_otx,
ti_threatq, tines, zerofox, zeronetworks
@efd6 efd6 merged commit d39e7c6 into elastic:main Jul 7, 2023
4 checks passed
@elasticmachine
Copy link

Package akamai - 2.11.0 containing this change is available at https://epr.elastic.co/search?package=akamai

@elasticmachine
Copy link

Package atlassian_bitbucket - 1.12.0 containing this change is available at https://epr.elastic.co/search?package=atlassian_bitbucket

@elasticmachine
Copy link

Package atlassian_confluence - 1.13.0 containing this change is available at https://epr.elastic.co/search?package=atlassian_confluence

@elasticmachine
Copy link

Package atlassian_jira - 1.13.0 containing this change is available at https://epr.elastic.co/search?package=atlassian_jira

@elasticmachine
Copy link

Package bitdefender - 1.1.0 containing this change is available at https://epr.elastic.co/search?package=bitdefender

@elasticmachine
Copy link

Package box_events - 1.6.0 containing this change is available at https://epr.elastic.co/search?package=box_events

@elasticmachine
Copy link

Package cisco_secure_endpoint - 2.16.0 containing this change is available at https://epr.elastic.co/search?package=cisco_secure_endpoint

@elasticmachine
Copy link

Package cloudflare - 2.11.0 containing this change is available at https://epr.elastic.co/search?package=cloudflare

@elasticmachine
Copy link

Package forgerock - 1.4.0 containing this change is available at https://epr.elastic.co/search?package=forgerock

@elasticmachine
Copy link

Package github - 1.15.0 containing this change is available at https://epr.elastic.co/search?package=github

@elasticmachine
Copy link

Package jumpcloud - 1.1.0 containing this change is available at https://epr.elastic.co/search?package=jumpcloud

@elasticmachine
Copy link

Package m365_defender - 1.12.0 containing this change is available at https://epr.elastic.co/search?package=m365_defender

@elasticmachine
Copy link

Package microsoft_defender_endpoint - 2.14.0 containing this change is available at https://epr.elastic.co/search?package=microsoft_defender_endpoint

@elasticmachine
Copy link

Package microsoft_exchange_online_message_trace - 1.6.0 containing this change is available at https://epr.elastic.co/search?package=microsoft_exchange_online_message_trace

@elasticmachine
Copy link

Package mimecast - 1.12.0 containing this change is available at https://epr.elastic.co/search?package=mimecast

@elasticmachine
Copy link

Package okta - 1.23.0 containing this change is available at https://epr.elastic.co/search?package=okta

@elasticmachine
Copy link

Package panw_cortex_xdr - 1.13.0 containing this change is available at https://epr.elastic.co/search?package=panw_cortex_xdr

@elasticmachine
Copy link

Package slack - 1.7.0 containing this change is available at https://epr.elastic.co/search?package=slack

@elasticmachine
Copy link

Package ti_abusech - 1.14.0 containing this change is available at https://epr.elastic.co/search?package=ti_abusech

@elasticmachine
Copy link

Package ti_cif3 - 1.1.0 containing this change is available at https://epr.elastic.co/search?package=ti_cif3

@elasticmachine
Copy link

Package ti_cybersixgill - 1.15.0 containing this change is available at https://epr.elastic.co/search?package=ti_cybersixgill

@elasticmachine
Copy link

Package ti_misp - 1.17.0 containing this change is available at https://epr.elastic.co/search?package=ti_misp

@elasticmachine
Copy link

Package ti_otx - 1.12.0 containing this change is available at https://epr.elastic.co/search?package=ti_otx

@elasticmachine
Copy link

Package ti_threatq - 1.13.0 containing this change is available at https://epr.elastic.co/search?package=ti_threatq

@elasticmachine
Copy link

Package tines - 1.1.0 containing this change is available at https://epr.elastic.co/search?package=tines

@elasticmachine
Copy link

Package zerofox - 1.13.0 containing this change is available at https://epr.elastic.co/search?package=zerofox

@elasticmachine
Copy link

Package zeronetworks - 1.1.0 containing this change is available at https://epr.elastic.co/search?package=zeronetworks

gizas pushed a commit that referenced this pull request Sep 5, 2023
@efd6 @gizas
all: document valid interval duration units. (#6706)
dfb366d 
Not all acceptable units are listed, but rather choose commonly used units that
are already documented in other packages.

akamai, atlassian_bitbucket, atlassian_confluence, atlassian_jira, bitdefender,
box_events, cisco_secure_endpoint, cloudflare, cloudflare, forgerock, github,
github, jumpcloud, m365_defender, microsoft_defender_endpoint,
microsoft_exchange_online_message_trace, mimecast, okta, panw_cortex_xdr, slack,
ti_abusech, ti_cif3, ti_cybersixgill, ti_cybersixgill, ti_misp, ti_otx,
ti_threatq, tines, zerofox, zeronetworks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@andrewkroh andrewkroh andrewkroh approved these changes

Assignees

@efd6 efd6

Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@efd6 @elasticmachine @andrewkroh