Skip to content
This repository was archived by the owner on Aug 2, 2022. It is now read-only.

Telemetry - add cppkin support - #9358

Merged
heifner merged 30 commits into
develop-boxedfrom
telemtry
Aug 17, 2020
Merged

Telemetry - add cppkin support#9358
heifner merged 30 commits into
develop-boxedfrom
telemtry

Conversation

@heifner

@heifner heifner commented Aug 4, 2020 •
edited
Loading

Copy link
Copy Markdown
Contributor

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

Emory Barlow and others added 22 commits July 27, 2020 11:52
Emory Barlow @heifner
init cppkin
228f96d
Emory Barlow @heifner
Add install of eosio cppkin
6862a07
@heifner
add optional ENABLE_CPPKIN option
fc6c9d9
@heifner
Add cppkin plugin for configuration
ed74566
@heifner
Add sample count option
6054c5d
@heifner
Added scoped_exit for calling Submit
0b21cf6
@heifner
Enable cppkin for cicd build
1568753
@heifner
Add cppkin
a9485c0
@heifner
Add cppkin_plugin
5ede140
@heifner
Add trace info for block creation
bbf599f
@heifner
Add trace of input transaction
02963d1
@heifner
Add trace of input transaction
4b25285
@heifner
Add block level tracing to rodeos
63d779f
@heifner
cppkin expects int
48a0869
@heifner
create block_id strings without quotes
2b254e6
@heifner
Upgrade to EOSIO/cppkin v1.2.0
8acac27
@heifner
Guard calls to cppkin when not enabled as cppkin can core dump when n…
2dfc2b7 
…o endpoint provided
@heifner
Make cppkin-endpoint required if using cppkin_plugin
d35f7d3
@heifner
Post trx result on thread pool
1baa21b
@heifner
Revert "Post trx result on thread pool"
0280248 
This reverts commit 1baa21b.

Performance was worse not better.
@heifner
Call accept_transaction from amqp thread
6426262
@heifner
Revert "Call accept_transaction from amqp thread"
e48b1ed 
This reverts commit 6426262.

Did not improve performance
@heifner

heifner commented Aug 5, 2020

Copy link
Copy Markdown
Contributor Author

Example Zipkin
Submitted:
image

Processed:
image

AMQP Submitted:
image

AMQP Processed:
image

Block Accepted:
image

SHiP Accepted:
image

@gleehokie

gleehokie commented Aug 13, 2020

Copy link
Copy Markdown
Contributor

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

heifner commented Aug 13, 2020

Copy link
Copy Markdown
Contributor Author

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.

swatanabe-b1
swatanabe-b1 reviewed Aug 13, 2020
View reviewed changes
Comment thread libraries/fc/include/fc/log/trace.hpp Outdated
Comment thread libraries/fc/include/fc/log/trace.hpp Outdated
Comment thread programs/nodeos/main.cpp Outdated
Comment thread plugins/state_history_plugin/state_history_plugin.cpp
Comment thread libraries/fc/include/fc/log/trace.hpp Outdated
Comment thread plugins/cppkin_plugin/cppkin_plugin.cpp
swatanabe-b1
swatanabe-b1 reviewed Aug 14, 2020
View reviewed changes
Comment thread libraries/fc/include/fc/log/trace.hpp Outdated
@heifner

heifner commented Aug 14, 2020

Copy link
Copy Markdown
Contributor Author

@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.

@heifner
heifner merged commit 284529f into develop-boxed Aug 17, 2020
@heifner
heifner deleted the telemtry branch August 17, 2020 11:32
@heifner heifner mentioned this pull request Oct 20, 2020
Merged
7 tasks
This was referenced Nov 3, 2020
Merged
Merged
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

1 more reviewer
@swatanabe-b1 swatanabe-b1 swatanabe-b1 approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@heifner @gleehokie @swatanabe-b1