nameko-eventlog-dispatcher 0.4.2

用法

from nameko.rpc import rpc
from nameko_eventlog_dispatcher import EventLogDispatcher


class FooService:

    name = 'foo'

    eventlog_dispatcher = EventLogDispatcher()

    @rpc
    def foo_method(self):
        self.eventlog_dispatcher(
          'foo_event_type', {'value': 1}, metadata={'meta': 2}
        )

from nameko.events import event_handler


class BarService:

    name = 'bar'

    @event_handler('foo', 'log_event')
    def foo_log_event_handler(self, body):
        """`body` will contain the event log data."""

# config.yaml

EVENTLOG_DISPATCHER:
  auto_capture: true
  entrypoints_to_exclude: []
  event_type: log_event

事件日志数据的格式

这是事件日志数据的格式

{
  "service_name": "foo",
  "entrypoint_protocol": "Rpc",
  "entrypoint_name": "foo_method",
  "call_id": "foo.foo_method.d7e907ee-9425-48a6-84e6-89db19e3ce50",
  "call_stack": [
    "standalone_rpc_proxy.call.3f349ea4-ed3e-4a3b-93d0-a36fbf928ecb",
    "bla.bla_method.21d623b4-edc4-4232-9957-4fad72533b75",
    "foo.foo_method.d7e907ee-9425-48a6-84e6-89db19e3ce50"
  ],

  "event_type": "foo_event_type",  # "entrypoint_fired", ...
  "timestamp": "2017-06-12T13:48:16+00:00",

  "meta": 2,  # extra information provided as "metadata"
  "data": {"value": 1}  # extra information provided as "event_data"
}

data属性将包含在分发事件时作为event_data参数提供的事件数据。

如果提供了metadata，则其元素将作为事件日志数据中的顶级属性包括在内。

测试

假设在默认URI guest:guest@localhost上运行着默认端口上的RabbitMQ，并使用默认端口。有一个Makefile目标，用于在本地使用默认端口和配置运行RabbitMQ Docker容器

$ make docker-rabbitmq-run

在本地运行测试

$ # Create/activate a virtual environment
$ pip install tox
$ tox

还有其他Makefile目标可以运行测试，但需要安装额外的依赖项

$ pip install -U --editable ".[dev]"
$ make test
$ make coverage

可以通过提供不同的RabbitMQ URI来覆盖以下环境变量：RABBIT_CTL_URI和AMQP_URI。

还可以通过使用ARGS变量提供额外的pytest参数

$ make test RABBIT_CTL_URI=http://guest:guest@dockermachine:15673 AMQP_URI=amqp://guest:guest@dockermachine:5673 ARGS='-x -vv --disable-pytest-warnings'
$ make coverage RABBIT_CTL_URI=http://guest:guest@dockermachine:15673 AMQP_URI=amqp://guest:guest@dockermachine:5673 ARGS='-x -vv --disable-pytest-warnings'

Nameko支持

以下Nameko版本受到支持

• 2.x系列：2.12、2.13、2.14

更改日志

请参阅CHANGELOG文档，了解每个版本的修复和增强。

许可证

MIT许可证。有关详细信息，请参阅LICENSE。