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 15 package view 16 17 // Exporter exports the collected records as view data. 18 // 19 // The ExportView method should return quickly; if an 20 // Exporter takes a significant amount of time to 21 // process a Data, that work should be done on another goroutine. 22 // 23 // It is safe to assume that ExportView will not be called concurrently from 24 // multiple goroutines. 25 // 26 // The Data should not be modified. 27 type Exporter interface { 28 ExportView(viewData *Data) 29 } 30 31 // RegisterExporter registers an exporter. 32 // Collected data will be reported via all the 33 // registered exporters. Once you no longer 34 // want data to be exported, invoke UnregisterExporter 35 // with the previously registered exporter. 36 // 37 // Binaries can register exporters, libraries shouldn't register exporters. 38 func RegisterExporter(e Exporter) { 39 defaultWorker.RegisterExporter(e) 40 } 41 42 // UnregisterExporter unregisters an exporter. 43 func UnregisterExporter(e Exporter) { 44 defaultWorker.UnregisterExporter(e) 45 } 46