1 /* 2 * 3 * Copyright 2019 gRPC authors. 4 * 5 * Licensed under the Apache License, Version 2.0 (the "License"); 6 * you may not use this file except in compliance with the License. 7 * You may obtain a copy of the License at 8 * 9 * http://www.apache.org/licenses/LICENSE-2.0 10 * 11 * Unless required by applicable law or agreed to in writing, software 12 * distributed under the License is distributed on an "AS IS" BASIS, 13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 * See the License for the specific language governing permissions and 15 * limitations under the License. 16 * 17 */ 18 19 #ifndef GRPCPP_OPENCENSUS_H 20 #define GRPCPP_OPENCENSUS_H 21 22 #include "opencensus/trace/span.h" 23 24 namespace grpc { 25 class ServerContext; 26 // These symbols in this file will not be included in the binary unless 27 // grpc_opencensus_plugin build target was added as a dependency. At the moment 28 // it is only setup to be built with Bazel. 29 30 // Registers the OpenCensus plugin with gRPC, so that it will be used for future 31 // RPCs. This must be called before any views are created. 32 void RegisterOpenCensusPlugin(); 33 34 // RPC stats definitions, defined by 35 // https://github.com/census-instrumentation/opencensus-specs/blob/master/stats/gRPC.md 36 37 // Registers the cumulative gRPC views so that they will be exported by any 38 // registered stats exporter. For on-task stats, construct a View using the 39 // ViewDescriptors below. 40 void RegisterOpenCensusViewsForExport(); 41 42 // Returns the tracing Span for the current RPC. 43 ::opencensus::trace::Span GetSpanFromServerContext(ServerContext* context); 44 45 } // namespace grpc 46 47 #endif // GRPCPP_OPENCENSUS_H 48