Skip to content

[chore][receiver/sqlserver] provide one generic configuration in readme #40851

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

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

cuichenli
Copy link
Contributor

Description

we now have many different configurations but the current readme does not have one generic readme that user can use directly.

Link to tracking issue

Fixes

Testing

Documentation

/cc @natalie-arsky

@cuichenli cuichenli requested review from crobert-1 and a team as code owners June 21, 2025 03:50
@github-actions github-actions bot added receiver/sqlserver Run Windows Enable running windows test on a PR labels Jun 21, 2025
Copy link
Member

@crobert-1 crobert-1 left a comment

Choose a reason for hiding this comment

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

Mostly just wording nits, thanks for adding!

@crobert-1 crobert-1 added the ready to merge Code review completed; ready to merge by maintainers label Jun 25, 2025
@cuichenli
Copy link
Contributor Author

cuichenli commented Jun 26, 2025

please do not merge this pr yet. i noticed there might be something wrong with the configuration
updated

server: sqlserver.address
port: 1433
events:
db.server.query_sample:
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Currently, to enable or disable a collection, we have to configure it under events rather than within the collection-related section. Personally, I find this a bit unintuitive.

Do you think it would be feasible to modify this on mdatagen side, so that enable/disable configuration could live in the same section as the rest of the collection settings?
@sincejune

Copy link
Contributor

Choose a reason for hiding this comment

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

The solution I came up with is to add a parameters section to the metadata file, structured as follows:

parameters:
  <param>:
    type: int
    default: <default_value>

events:
  default_event:
    attributes: [...]
    parameters:
      <param>: <value>

This approach works well for parameters that will be used within a single collection. However, it may not be ideal for parameters that need to be shared across multiple collections (e.g., metrics or events).

@dmitryax what do you think?

@crobert-1 crobert-1 removed the ready to merge Code review completed; ready to merge by maintainers label Jun 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
receiver/sqlserver Run Windows Enable running windows test on a PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants