export.go 1.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  1. // Copyright 2017, OpenCensus Authors
  2. //
  3. // Licensed under the Apache License, Version 2.0 (the "License");
  4. // you may not use this file except in compliance with the License.
  5. // You may obtain a copy of the License at
  6. //
  7. // http://www.apache.org/licenses/LICENSE-2.0
  8. //
  9. // Unless required by applicable law or agreed to in writing, software
  10. // distributed under the License is distributed on an "AS IS" BASIS,
  11. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. // See the License for the specific language governing permissions and
  13. // limitations under the License.
  14. package view
  15. // Exporter exports the collected records as view data.
  16. //
  17. // The ExportView method should return quickly; if an
  18. // Exporter takes a significant amount of time to
  19. // process a Data, that work should be done on another goroutine.
  20. //
  21. // It is safe to assume that ExportView will not be called concurrently from
  22. // multiple goroutines.
  23. //
  24. // The Data should not be modified.
  25. type Exporter interface {
  26. ExportView(viewData *Data)
  27. }
  28. // RegisterExporter registers an exporter.
  29. // Collected data will be reported via all the
  30. // registered exporters. Once you no longer
  31. // want data to be exported, invoke UnregisterExporter
  32. // with the previously registered exporter.
  33. //
  34. // Binaries can register exporters, libraries shouldn't register exporters.
  35. func RegisterExporter(e Exporter) {
  36. defaultWorker.RegisterExporter(e)
  37. }
  38. // UnregisterExporter unregisters an exporter.
  39. func UnregisterExporter(e Exporter) {
  40. defaultWorker.UnregisterExporter(e)
  41. }