Skip to content

Conversation

@shmsr
Copy link
Member

@shmsr shmsr commented Feb 19, 2025

Proposed commit message

Reduce data granularity by changing the default bucket width of 1d to 1m (1 day to 1 minute). Have also updated the documentation to clearly mention the collection behaviour, storage implications, how granularity affects, etc.

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.
  • I have verified that any added dashboard complies with Kibana's Dashboard good practices

@shmsr shmsr requested a review from a team as a code owner February 19, 2025 08:15
@shmsr shmsr requested a review from alaudazzi February 19, 2025 08:15
@shmsr shmsr self-assigned this Feb 19, 2025
@shmsr shmsr added documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. bugfix Pull request that fixes a bug issue Team:Obs-InfraObs Observability Infrastructure Monitoring team [elastic/obs-infraobs-integrations] labels Feb 19, 2025
@shmsr shmsr changed the title packages/openai: Fix typo in documentation packages/openai: <TODO TITLE> Feb 19, 2025
@shmsr shmsr changed the title packages/openai: <TODO TITLE> packages/openai: Change default bucket_width and improve documentation Feb 20, 2025
Copy link

@daniela-elastic daniela-elastic left a comment

Choose a reason for hiding this comment

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

Left minor comments in-line. And a final suggestion to potentially add a description of what a bucket is (or a link to the definition to OpenAI web site). Other than that looks good.

@shmsr
Copy link
Member Author

shmsr commented Feb 25, 2025

Left minor comments in-line. And a final suggestion to potentially add a description of what a bucket is (or a link to the definition to OpenAI web site). Other than that looks good.

Thanks.

And a final suggestion to potentially add a description of what a bucket is (or a link to the definition to OpenAI web site)

So, if you look at L52 of the docs, I have mentioned it there:

  • Controls the time-based aggregation of metrics (e.g., bucket_width)

I have linked it as well.

The link does show the definition for the field:

Width of each time bucket in response. Currently 1m, 1h and 1d are supported, default to 1d.

There's nothing more on bucket width in OpenAI's website.

Copy link
Contributor

@alaudazzi alaudazzi left a comment

Choose a reason for hiding this comment

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

I reviewed the MD file and left a few suggestions.

Copy link
Contributor

@alaudazzi alaudazzi left a comment

Choose a reason for hiding this comment

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

LGTM for the documentation part.

@daniela-elastic
Copy link

So, if you look at L52 of the docs, I have mentioned it there:

  • Controls the time-based aggregation of metrics (e.g., bucket_width)

I meant add an explanation (or link) to the definition of bucket, not only bucket width. If you are introducing the concept of a bucket then we should be explaining what it actually is. And then we can talk about bucket width

@shmsr
Copy link
Member Author

shmsr commented Feb 26, 2025

So, if you look at L52 of the docs, I have mentioned it there:

  • Controls the time-based aggregation of metrics (e.g., bucket_width)

I meant add an explanation (or link) to the definition of bucket, not only bucket width. If you are introducing the concept of a bucket then we should be explaining what it actually is. And then we can talk about bucket width

Done!

Co-authored-by: Ishleen Kaur <102962586+ishleenk17@users.noreply.github.com>
shmsr

This comment was marked as duplicate.

@shmsr shmsr added enhancement New feature or request and removed bugfix Pull request that fixes a bug issue labels Feb 27, 2025
@shmsr shmsr changed the title packages/openai: Change default bucket_width and improve documentation packages/openai: Change default bucket_width and improve documentation and field descriptions Feb 27, 2025
@shmsr shmsr added the Integration:openai OpenAI label Feb 27, 2025
@elasticmachine
Copy link

💚 Build Succeeded

History

cc @shmsr

@elastic-sonarqube
Copy link

Quality Gate failed Quality Gate failed

Failed conditions
0.0% Coverage on New Code (required ≥ 80%)

See analysis details on SonarQube

@shmsr shmsr merged commit 14baf2e into elastic:main Feb 27, 2025
5 of 6 checks passed
@elastic-vault-github-plugin-prod

Package openai - 0.3.0 containing this change is available at https://epr.elastic.co/package/openai/0.3.0/

flexitrev pushed a commit that referenced this pull request Mar 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. enhancement New feature or request Integration:openai OpenAI Team:Obs-InfraObs Observability Infrastructure Monitoring team [elastic/obs-infraobs-integrations]

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants