Skip to content
This repository has been archived by the owner on Jul 31, 2023. It is now read-only.

doc: add SetReportingPeriod recommendations #910

Merged
merged 2 commits into from
Sep 12, 2018
Merged

doc: add SetReportingPeriod recommendations #910

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9ae82d5
doc: add SetReportingPeriod recommendations
jeanbza Sep 11, 2018
4e2d845
remove ;
jeanbza Sep 11, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions stats/view/worker.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,8 +116,12 @@ func record(tags *tag.Map, ms interface{}) {
}

// SetReportingPeriod sets the interval between reporting aggregated views in
// the program. If duration is less than or
// equal to zero, it enables the default behavior.
// the program. If duration is less than or equal to zero, it enables the
// default behavior.
//
// Note: each exporter makes different promises about what the lowest supported
Copy link
Member

Choose a reason for hiding this comment

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

Nice, thank you! It would be nice to also mail a change to the actual stackdriver exporter repo providing an advisory for this time duration.

Copy link
Member

Choose a reason for hiding this comment

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

@songy23 I see you initially mailed census-ecosystem/opencensus-go-exporter-stackdriver#37 but closed it. Will you perhaps be making an update in light of this new PR?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes, the Stackdriver example is already updated in census-ecosystem/opencensus-go-exporter-stackdriver#38.

// duration is. For example, the Stackdriver exporter recommends a value no
// lower than 1 minute. Consult each exporter per your needs.
func SetReportingPeriod(d time.Duration) {
// TODO(acetechnologist): ensure that the duration d is more than a certain
// value. e.g. 1s
Expand Down