1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215
|
// Copyright 2022 The OpenZipkin Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
/*
Package amqp implements a RabbitMq reporter to send spans to a Rabbit server/cluster.
*/
package amqp
import (
"encoding/json"
"fmt"
"log"
"os"
amqp "github.com/rabbitmq/amqp091-go"
"github.com/openzipkin/zipkin-go/model"
"github.com/openzipkin/zipkin-go/reporter"
)
// defaultRmqRoutingKey/Exchange/Kind sets the standard RabbitMQ queue our Reporter will publish on.
const (
defaultRmqRoutingKey = "zipkin"
defaultRmqExchange = "zipkin"
defaultExchangeKind = "direct"
)
// rmqReporter implements Reporter by publishing spans to a RabbitMQ exchange
type rmqReporter struct {
e chan error
channel *amqp.Channel
conn *amqp.Connection
exchange string
queue string
logger *log.Logger
}
// ReporterOption sets a parameter for the rmqReporter
type ReporterOption func(c *rmqReporter)
// Logger sets the logger used to report errors in the collection
// process.
func Logger(logger *log.Logger) ReporterOption {
return func(c *rmqReporter) {
c.logger = logger
}
}
// Exchange sets the Exchange used to send messages (
// see https://github.com/openzipkin/zipkin/tree/master/zipkin-collector/rabbitmq
// if want to change default routing key or exchange
func Exchange(exchange string) ReporterOption {
return func(c *rmqReporter) {
c.exchange = exchange
}
}
// Queue sets the Queue used to send messages
func Queue(queue string) ReporterOption {
return func(c *rmqReporter) {
c.queue = queue
}
}
// Channel sets the Channel used to send messages
func Channel(ch *amqp.Channel) ReporterOption {
return func(c *rmqReporter) {
c.channel = ch
}
}
// Connection sets the Connection used to send messages
func Connection(conn *amqp.Connection) ReporterOption {
return func(c *rmqReporter) {
c.conn = conn
}
}
// NewReporter returns a new RabbitMq-backed Reporter. address should be as described here: https://www.rabbitmq.com/uri-spec.html
func NewReporter(address string, options ...ReporterOption) (reporter.Reporter, error) {
r := &rmqReporter{
logger: log.New(os.Stderr, "", log.LstdFlags),
queue: defaultRmqRoutingKey,
exchange: defaultRmqExchange,
e: make(chan error),
}
for _, option := range options {
option(r)
}
checks := []func() error{
r.queueVerify,
r.exchangeVerify,
r.queueBindVerify,
}
var err error
if r.conn == nil {
r.conn, err = amqp.Dial(address)
if err != nil {
return nil, err
}
}
if r.channel == nil {
r.channel, err = r.conn.Channel()
if err != nil {
return nil, err
}
}
for i := 0; i < len(checks); i++ {
if err := checks[i](); err != nil {
return nil, err
}
}
go r.logErrors()
return r, nil
}
func (r *rmqReporter) logErrors() {
for err := range r.e {
r.logger.Print("msg", err.Error())
}
}
func (r *rmqReporter) Send(s model.SpanModel) {
// Zipkin expects the message to be wrapped in an array
ss := []model.SpanModel{s}
m, err := json.Marshal(ss)
if err != nil {
r.e <- fmt.Errorf("failed when marshalling the span: %s", err.Error())
return
}
msg := amqp.Publishing{
Body: m,
}
err = r.channel.Publish(defaultRmqExchange, defaultRmqRoutingKey, false, false, msg)
if err != nil {
r.e <- fmt.Errorf("failed when publishing the span: %s", err.Error())
}
}
func (r *rmqReporter) queueBindVerify() error {
return r.channel.QueueBind(
defaultRmqRoutingKey,
defaultRmqRoutingKey,
defaultRmqExchange,
false,
nil)
}
func (r *rmqReporter) exchangeVerify() error {
err := r.channel.ExchangeDeclare(
defaultRmqExchange,
defaultExchangeKind,
true,
false,
false,
false,
nil,
)
if err != nil {
return err
}
return nil
}
func (r *rmqReporter) queueVerify() error {
_, err := r.channel.QueueDeclare(
defaultRmqExchange,
true,
false,
false,
false,
nil,
)
if err != nil {
return err
}
return nil
}
func (r *rmqReporter) Close() error {
err := r.channel.Close()
if err != nil {
return err
}
err = r.conn.Close()
if err != nil {
return err
}
return nil
}
|