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

Clean up and update metadata files for IIS, MSSQL, and MySQL/MariaDB. #1777

Merged
merged 5 commits into from
Aug 14, 2024

Conversation

igorpeshansky
Copy link
Member

@igorpeshansky igorpeshansky commented Aug 13, 2024

Description

Bring the third-party metadata.yaml files for IIS, MSSQL, and MySQL/MariaDB up-to-date with the public docs, in preparation for eventually using them as the source of truth.

A follow-on to #1772.

Related issue

b/240700717
b/356682372

How has this been tested?

All of the metadata.yaml changes have been run through an automatic doc generator and compared with the existing documentation. The added third-party application tests have passed.

Checklist:

  • Unit tests
    • Unit tests do not apply.
    • Unit tests have been added/modified and passed for this PR.
  • Integration tests
    • Integration tests do not apply.
    • Integration tests have been added/modified and passed for this PR.
  • Documentation
    • This PR introduces no user visible changes.
    • This PR introduces user visible changes and the corresponding documentation change has been made.
  • Minor version bump
    • This PR introduces no new features.
    • This PR introduces new features, and there is a separate PR to bump the minor version since the last release already.
    • This PR bumps the version.

@igorpeshansky igorpeshansky force-pushed the igorpeshansky-third-party-docs-update branch from 2e35b05 to e8934ce Compare August 13, 2024 19:54
Copy link
Collaborator

@mtabasko mtabasko left a comment

Choose a reason for hiding this comment

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

The doc-related files look fine to me.

Also don't crash on empty feature lists in third-party tests.
Use the first matching reason for skipping the test platform.
@igorpeshansky igorpeshansky force-pushed the igorpeshansky-third-party-docs-update branch from 2a1542c to 6763932 Compare August 14, 2024 15:57
@igorpeshansky igorpeshansky force-pushed the igorpeshansky-third-party-docs-update branch from eb74799 to 4f26a11 Compare August 14, 2024 18:10
@igorpeshansky igorpeshansky force-pushed the igorpeshansky-third-party-docs-update branch from 4f26a11 to 46c13a2 Compare August 14, 2024 18:15
@jefferbrecht
Copy link
Member

Now that we have separate folders for v1 and v2, does it make sense to update the v2 enable scripts (IIS, MSSQL) so that they only test v2 rather than v1+v2 simultaneously?

@igorpeshansky
Copy link
Member Author

Now that we have separate folders for v1 and v2, does it make sense to update the v2 enable scripts (IIS, MSSQL) so that they only test v2 rather than v1+v2 simultaneously?

Do you mean putting the iis/mssql v2 receivers into the default_pipeline?

@jefferbrecht
Copy link
Member

Now that we have separate folders for v1 and v2, does it make sense to update the v2 enable scripts (IIS, MSSQL) so that they only test v2 rather than v1+v2 simultaneously?

Do you mean putting the iis/mssql v2 receivers into the default_pipeline?

Sure, either that or overwriting the built-in iis/mssql receivers.

@igorpeshansky
Copy link
Member Author

Now that we have separate folders for v1 and v2, does it make sense to update the v2 enable scripts (IIS, MSSQL) so that they only test v2 rather than v1+v2 simultaneously?

Do you mean putting the iis/mssql v2 receivers into the default_pipeline?

Sure, either that or overwriting the built-in iis/mssql receivers.

Right, putting them in the default_pipeline is exactly the way to override the built-in ones. I don't think it's a good idea, because those enable files are also used as example configurations in the docs, and we don't necessarily want to encourage users to override the built-in receivers. The default receivers are harmless, in that they only add a few metrics that we (now) don't even check, so I'd just leave them alone.

@igorpeshansky igorpeshansky merged commit faf464b into master Aug 14, 2024
60 checks passed
@igorpeshansky igorpeshansky deleted the igorpeshansky-third-party-docs-update branch August 14, 2024 22:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants