Telemetry - add cppkin support

[heifner]

Change Description

• Add support for https://github.com/EOSIO/cppKin via new cppkin_plugin
• EOSIO/cppkin support both Zipkin and New Relic
• Enabled by new CMake option: ENABLE_CPPKIN
  -- Needs EOSIO/cppkin installed to build

Adds cppkin logging for http/amqp transactions, block production, SHiP block receive/send, rodoes block receive/processed.

Trace entries added:

• amqp_trx_plugin
  -- Trace: "Transaction", Span: "AMQP Received", Tag: "trx_id" [received an input transaction from AMQP "trx" queue]
  -- Trace: "Transaction", Span: "Processed", Tag: "trx_id" [executed transaction and placed in pending block]
  ---- Includes: Tags: "block_num", "block_time", "elapsed" and either "status" or "error"

• chain_plugin
  -- Trace: "Transaction", Span: "HTTP Received", Tag: "trx_id" [received an input transaction from http push_transaction]
  -- Trace: "Transaction", Span: "Processed", Tag: "trx_id" [executed transaction and placed in pending block]
  ---- Includes: Tags: "block_num", "block_time", "elapsed" and either "status" or "error"
  -- Trace: "Transaction", Span: "HTTP Received", Tag: "trx_id" [received an input transaction from http send_transaction]
  -- Trace: "Transaction", Span: "Processed", Tag: "trx_id" [executed transaction and placed in pending block]
  ---- Includes: Tags: "block_num", "block_time", "elapsed" and either "status" or "error"

• net_plugin
  -- Trace: "Block", Span: "Accepted", Tags: "block_id", "block_num", "block_time"
  -- Trace: "Block", Span: "PreAccepted", Tags: "block_id", "block_num", "block_time", "producer" [Logged when trusted producer allows for sending of block before processing]

• state_history_plugin
  -- Trace: "Block", Span: "SHiP-Accepted", Tags: "block_id", "block_num", "block_time"
  -- Trace: "Block", Span: "SHiP-Send", Tags: "block_id", "block_num", "block_time"

• rodeos
  -- Trace: "Block", Span: "rodeos-received", Tags: "block_id", "block_num", "block_time"
  -- Trace: "Block", Span: "Filter-Start", Tags: "block_num"
  -- Trace: "Block", Span: "Filter-Stop", Tags: "block_num"

Change Type

Select ONE

• Documentation

• Stability bug fix

• Other

• Other - special case

Consensus Changes

• Consensus Changes

API Changes

• API Changes

Documentation Additions

• Documentation Additions

• New plugin cppkin_plugin for both nodeos and rodeos

  Config Options for eosio::cppkin_plugin:
  --cppkin-endpoint arg cppkin connection endpoint (required)
  --cppkin-service-name arg cppkin service name
  --cppkin-api-key arg cppkin API Key
  --cppkin-sample-count arg (=1) cppkin sample count

[heifner]

Example Zipkin
Submitted:

Processed:

AMQP Submitted:

AMQP Processed:

Block Accepted:

SHiP Accepted:

[gleehokie]

The name “cppkin”, while obviously a play on Zipkin, is not descriptive of what this module does. Would a better name be “telemetry” or something like that?

[heifner]

The name “cppkin”, while obviously a play on Zipkin, is not descriptive of what this module does. Would a better name be “telemetry” or something like that?

Happy to name it whatever you like. Any suggestions? telemetry_plugin ? It is named cppkin_plugin because it uses the EOSIO/cppkin library for sending info to Zipkin & New Relic.

[heifner]

@gleehokie these changes are particular to EOSIO/cppkin; the cppkin_plugin is specific to EOSIO/cppkin. As such I don't think it makes sense to name it telemetry_plugin. We could potentially have other telemetry support added in the future. As this is now it is not a general telemetry solution.

I plan on merging this PR now. If you feel strongly about renaming, I will happily do that in a follow-on PR.