RabbitMq-ConversationId与CorrelationId-哪个更适合跟踪特定请求?

时间:2019-03-21 16:42:38

标签: c# rabbitmq masstransit

RabbitMQ似乎具有两个非常相似的属性,我并不完全了解它们之间的区别。 ConversationIdCorrelationId

我的用例如下。我有一个生成Guid的网站。网站调用AP​​I,并将该唯一标识符添加到HttpRequest标头中。反过来,这会将消息发布到RabbitMQ。该消息由第一个使用者处理,然后传递到其他使用者,依此类推。

出于记录目的,我想记录一个将初始请求与所有后续操作联系在一起的标识符。对于整个应用程序不同部分的旅程而言,这应该是唯一的。因此。当登录到Serilog / ElasticSearch之类的文件时,可以很容易地看到哪个请求触发了初始请求,并且整个应用程序中该请求的所有日志条目都可以关联在一起。

我创建了一个提供程序,用于查看传入的HttpRequest中的标识符。我将其称为“ CorrelationId”,但我开始怀疑它是否应真正命名为“ ConversationId”。就RabbitMQ而言,“ ConversationId”的想法更适合此模型,还是“ CorrelationId”更好?

这两个概念有什么区别?

就代码而言,我希望做到以下几点。首先在我的API中注册总线,然后将SendPublish配置为使用提供者提供的CorrelationId

// bus registration in the API
var busSettings = context.Resolve<BusSettings>();
// using AspNetCoreCorrelationIdProvider
var correlationIdProvider = context.Resolve<ICorrelationIdProvider>();

var busControl = Bus.Factory.CreateUsingRabbitMq(cfg =>
{
    cfg.Host(
        new Uri(busSettings.HostAddress),
        h =>
        {
            h.Username(busSettings.Username);
            h.Password(busSettings.Password);
        });
    cfg.ConfigurePublish(x => x.UseSendExecute(sendContext =>
    {
        // which one is more appropriate
        //sendContext.ConversationId = correlationIdProvider.GetCorrelationId();
        sendContext.CorrelationId = correlationIdProvider.GetCorrelationId();
    }));
});

作为参考,这是我简单的提供程序界面

// define the interface
public interface ICorrelationIdProvider
{
    Guid GetCorrelationId();
}

还有AspNetCore实现,该实现提取调用方客户端(即网站)设置的唯一ID。

public class AspNetCoreCorrelationIdProvider : ICorrelationIdProvider
{
    private IHttpContextAccessor _httpContextAccessor;

    public AspNetCoreCorrelationIdProvider(IHttpContextAccessor httpContextAccessor)
    {
        _httpContextAccessor = httpContextAccessor;
    }

    public Guid GetCorrelationId()
    {
        if (_httpContextAccessor.HttpContext.Request.Headers.TryGetValue("correlation-Id", out StringValues headers))
        {
            var header = headers.FirstOrDefault();
            if (Guid.TryParse(header, out Guid headerCorrelationId))
            {
                return headerCorrelationId;
            }
        }

        return Guid.NewGuid();
    }
}

最后,我的服务主机是简单的Windows服务应用程序,用于存放和使用已发布的消息。他们使用以下代码获取CorrelationId,并很可能将其发布到其他使用者以及其他服务主机中。

public class MessageContextCorrelationIdProvider : ICorrelationIdProvider
{
    /// <summary>
    /// The consume context
    /// </summary>
    private readonly ConsumeContext _consumeContext;

    /// <summary>
    /// Initializes a new instance of the <see cref="MessageContextCorrelationIdProvider"/> class.
    /// </summary>
    /// <param name="consumeContext">The consume context.</param>
    public MessageContextCorrelationIdProvider(ConsumeContext consumeContext)
    {
        _consumeContext = consumeContext;
    }

    /// <summary>
    /// Gets the correlation identifier.
    /// </summary>
    /// <returns></returns>
    public Guid GetCorrelationId()
    {
        // correlationid or conversationIs?
        if (_consumeContext.CorrelationId.HasValue && _consumeContext.CorrelationId != Guid.Empty)
        {
            return _consumeContext.CorrelationId.Value;
        }

        return Guid.NewGuid();
    }
}

然后,我的使用者中有一个记录器,该记录器使用该提供程序来提取CorrelationId

public async Task Consume(ConsumeContext<IMyEvent> context)
{
    var correlationId = _correlationProvider.GetCorrelationId();
    _logger.Info(correlationId, $"#### IMyEvent received for customer:{context.Message.CustomerId}");

    try
    {
        await _mediator.Send(new SomeOtherRequest(correlationId) { SomeObject: context.Message.SomeObject });
    }
    catch (Exception e)
    {
        _logger.Exception(e, correlationId, $"Exception:{e}");
        throw;
    }

    _logger.Info(correlationId, $"Finished processing: {DateTime.Now}");
}

在阅读docs时,它对“ ConversationId”说了以下内容:

  

对话是由发送的第一条消息创建的,或者   已发布,没有可用的现有上下文(例如当   使用IBus.Send或IBus.Publish发送或发布邮件。如果   现有上下文用于发送或发布消息,   将ConversationId复制到新消息中,以确保   同一对话中的邮件具有相同的标识符。

现在,我开始认为我的术语混在一起了,从技术上讲,这是一次对话(尽管“对话”就像“电话游戏”一样。)

因此,在此用例中是CorrelationId还是ConversationId?请帮助我弄清楚我的术语!!

1 个答案:

答案 0 :(得分:2)

在消息对话中(提示性的乐谱),可能有一条消息(我告诉你去做某事,或者我告诉每个正在听某事的人)或多条消息(我告诉过你去做某事,然后您告诉其他人,或者我告诉每个正在听的人,发生了什么事,那些听众告诉了他们的朋友,依此类推,等等。

通过正确使用从第一条消息到最后一条消息的MassTransit,这些消息中的每个消息都将具有相同的ConversationId。在消息使用过程中,MassTransit将属性未经修改地从ConsumeContext复制到每个传出消息。这使所有内容都成为同一 trace 的一部分-对话。

但是,MassTransit默认未设置CorrelationId。如果消息属性命名为CorrelationId(或CommandId或EventId),则可以自动设置它,也可以添加自己的名称。

如果消耗的消息上存在CorrelationId,则所有传出消息都将具有该CorrelationId属性复制到InitiatorId属性(原因和效果-消耗的消息启动了后续消息的创建)。这形成了一条链(或跟踪术语中的跨度),可以遵循该链来显示初始消息中的消息传播。

应将CorrelationId视为命令或事件的标识符,以便可以在整个系统日志中看到该命令的效果。

在我看来,您从HTTP输入的内容可能是发起者,因此将该标识符复制到InitiatorId中并为消息创建一个新的CorrelationId,或者您可能只想对初始CorrelationId使用相同的标识符,并让随后的消息将其用作发起方。