grpc.go 2.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687
  1. // Copyright 2022 The OpenZipkin 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 b3
  15. import (
  16. "google.golang.org/grpc/metadata"
  17. "github.com/openzipkin/zipkin-go/model"
  18. "github.com/openzipkin/zipkin-go/propagation"
  19. )
  20. // ExtractGRPC will extract a span.Context from the gRPC Request metadata if
  21. // found in B3 header format.
  22. func ExtractGRPC(md *metadata.MD) propagation.Extractor {
  23. return func() (*model.SpanContext, error) {
  24. var (
  25. traceIDHeader = GetGRPCHeader(md, TraceID)
  26. spanIDHeader = GetGRPCHeader(md, SpanID)
  27. parentSpanIDHeader = GetGRPCHeader(md, ParentSpanID)
  28. sampledHeader = GetGRPCHeader(md, Sampled)
  29. flagsHeader = GetGRPCHeader(md, Flags)
  30. )
  31. return ParseHeaders(
  32. traceIDHeader, spanIDHeader, parentSpanIDHeader, sampledHeader,
  33. flagsHeader,
  34. )
  35. }
  36. }
  37. // InjectGRPC will inject a span.Context into gRPC metadata.
  38. func InjectGRPC(md *metadata.MD) propagation.Injector {
  39. return func(sc model.SpanContext) error {
  40. if (model.SpanContext{}) == sc {
  41. return ErrEmptyContext
  42. }
  43. if sc.Debug {
  44. setGRPCHeader(md, Flags, "1")
  45. } else if sc.Sampled != nil {
  46. // Debug is encoded as X-B3-Flags: 1. Since Debug implies Sampled,
  47. // we don't send "X-B3-Sampled" if Debug is set.
  48. if *sc.Sampled {
  49. setGRPCHeader(md, Sampled, "1")
  50. } else {
  51. setGRPCHeader(md, Sampled, "0")
  52. }
  53. }
  54. if !sc.TraceID.Empty() && sc.ID > 0 {
  55. // set identifiers
  56. setGRPCHeader(md, TraceID, sc.TraceID.String())
  57. setGRPCHeader(md, SpanID, sc.ID.String())
  58. if sc.ParentID != nil {
  59. setGRPCHeader(md, ParentSpanID, sc.ParentID.String())
  60. }
  61. }
  62. return nil
  63. }
  64. }
  65. // GetGRPCHeader retrieves the last value found for a particular key. If key is
  66. // not found it returns an empty string.
  67. func GetGRPCHeader(md *metadata.MD, key string) string {
  68. v := (*md)[key]
  69. if len(v) < 1 {
  70. return ""
  71. }
  72. return v[len(v)-1]
  73. }
  74. func setGRPCHeader(md *metadata.MD, key, value string) {
  75. (*md)[key] = append((*md)[key], value)
  76. }