[DOCS-15691] Investigate changes in SERVER-67598: Allow create command to set bucketMaxSpanSeconds and bucketRoundingSeconds directly Created: 19/Oct/22  Updated: 13/Nov/23  Resolved: 15/Nov/22

Status: Closed
Project: Documentation
Component/s: manual, Server
Affects Version/s: None
Fix Version/s: 6.2.0-rc0, Server_Docs_20231030, Server_Docs_20231106, Server_Docs_20231105, Server_Docs_20231113

Type: Task Priority: Major - P3
Reporter: Backlog - Core Eng Program Management Team Assignee: David Hou
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Documented
documents SERVER-67598 Allow create command to set bucketMax... Closed
Related
Participants:
Days since reply: 1 year, 12 weeks, 1 day ago
Epic Link: DOCSP-22092

 Description   
Original Downstream Change Summary

With this change, we make the create command time series option "granularity" an optional parameter (previously defaulted to 'seconds') and allow for users to specify "bucketMaxSpanSeconds" and "bucketRoundingSeconds" if "granularity" is not included in the command.

These bucketing parameters must be set alongside each other and must be equal to each other. If custom "bucketMaxSpanSeconds" and "bucketRoundingSeconds" values are passed through, "granularity" should not be included in the create command.

These parameters can only be changed to a higher value through the collMod command.

Description of Linked Ticket

We want to allow users to set 'bucketMaxSpanSeconds' and 'bucketRoundingSeconds' directly when they create a new time-series collection. We will enforce that 'bucketRoundingSeconds' is equal to 'bucketMaxSpanSeconds', and that both are strictly positive. If a user sets one value, they must set both. If a user sets these values, they cannot also set 'granularity'.

Context:

  • bucketMaxSpanSeconds: "The maximum range of time values for a bucket, in seconds"
  • bucketRoundingSeconds: "Used to determine the minimum time boundary when opening a new bucket by rounding the first timestamp down to the next multiple of this value. Specified in seconds."

Valid examples of timeseries options passed through to the create command:

  • {timeseries: {timeField: "time", granularity: "seconds"}} 
  • {timeseries: {timeField: "time", bucketRoundingSeconds: 3600, bucketMaxSpanSeconds: 3600}}
  • {timeseries: {timeField: "time", bucketRoundingSeconds: 8000, bucketMaxSpanSeconds: 8000}}
  • {timeseries: {timeField: "time", granularity: "seconds", bucketRoundingSeconds: 60, bucketMaxSpanSeconds: 3600}} // this is not an expected use case of the parameters but is allowed since the bucketMaxSpanSeconds and bucketRoundingSeconds are the default values corresponding to the 'seconds' granularity


 Comments   
Comment by Githook User [ 15/Nov/22 ]

Author:

{'name': 'davidhou17', 'email': '55004296+davidhou17@users.noreply.github.com', 'username': 'davidhou17'}

Message: Merge DOCS-15691 to v6.3: Additional timeseries options - bucketMaxSpanSeconds and bucketRoundingSeconds (#2143)

  • Changes to granularity and addition of two timeseries options
  • Add context about bucketing
  • resolve merge conflict
  • copy review feedback
  • copy review 2
  • tech review feedback
Comment by David Hou [ 15/Nov/22 ]

Merging to v6.3: https://github.com/10gen/docs-mongodb-internal/pull/2143

Comment by David Hou [ 11/Nov/22 ]

Hi Fausto, it looks like a docs ticket was generated for both the PM-2724 epic (marked 6.3) and SERVER-67598 (marked 6.2). If Dan clarifies that the project is targeted for 6.3, I can move these doc changes to our 6.3 feature branch and request another review from there. Let me know what you think!

Comment by Fausto Leyva (Inactive) [ 11/Nov/22 ]

Hi David, I notice this is linked to epic "6.2 Upcoming" but the project is targeted for 6.3 (and the modification of these new parameters are guarded by the project feature flag). Should we hold off on these doc changes until 6.3? 

CC: dan.larkin-york@mongodb.com 

Comment by Adrian Gonzalez Montemayor [ 11/Nov/22 ]

I'll definitely take a look, I also included fausto.leyva@mongodb.com  since he is currently working on this and has a better scope.

Comment by David Hou [ 11/Nov/22 ]

Hey adrian.gonzalez@mongodb.com, when you get a chance can you review this PR for technical accuracy? https://github.com/10gen/docs-mongodb-internal/pull/2124

Generated at Thu Feb 08 08:13:34 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.