`Logtail.with_context` in `around_action` not logging context

[tonydaly]

Heya, I'm looking at the example Rails project and the around_action example. However, I cannot get it to log the user context. The only difference I can see is that I'm using Rails API, so my ApplicationController inherits from ActionController::API. Any help appreciated.

[PetrHeinz]

Hello @tonydaly!

I've mocked up an API controller using user context in the example project, you can take a look 7a09cb8

There are no Users in the example project (it's pretty bare-bones), so the actual implementation of user_signed_in? an current_user depends on your project and how you handle users.

When someone visits /api route, all logs from within the controller action have context added:

Hope this helps! 👍

[tonydaly]

Hey @PetrHeinz thanks for this example, really appreciate it.

Maybe my expectation was wrong. When I use your example I get the user context logged, but only for the "Someone is calling our API." log line. I was hoping that it would be included in the other log lines for the request (just ran this myself and it's not included there). Most of my controller actions don't have specific log calls, so without it being included in the rails generated logs I'm not sure useful?

Hope that makes sense!

[PetrHeinz]

@tonydaly If you use Rails.logger in any code called from inside the controller, it should have the context included.

The other logs in the screenshot above don't have the context, because it's outside of the controller action.

Can you provide some more details about your project? Ideally some minimal code example of what you're trying to achieve. If you can call Logtail.with_context somewhere upstream of the code, you should be able to add context to it.

[PetrHeinz]

For example, you could use a middleware, similarly how SessionContext gets added.

[gertjanjansen]

I'm running into a similar issue. I am able to set the user context, but I'd like to have it set before the first log of a request is made ("Started GET ..."). I tried it by writing my own middleware but I can't get it to work. I even added my middleware with config.middleware.insert 0, LogtailContextMiddleware.

[Wittiest]

Hey everyone, I solved this for our use case (Logging GraphQL params inside of the automatic Rack logs) with the following code:

/lib/middleware/graphql_context.rb

  module Middleware
    # A Rack middleware that is responsible for adding the GraphQL context
    class GraphqlContext
      def initialize(app)
        @app = app
      end

      def call(env)
        operation_name = get_operation_name(env)
        if operation_name
          Logtail.with_context({ graphql: { operation_name:}}) do
            @app.call(env)
          end
        else
          @app.call(env)
        end
      end

    private

      def get_operation_name(env)
        request = Logtail::Util::Request.new(env)
        body = request.body_content
        return unless body

        json = JSON.parse(body)
        json['operationName']
      rescue JSON::ParserError, TypeError
        nil
      end
    end
  end

config/application.rb

config.middleware.insert_before Logtail::Integrations::Rack::HTTPEvents, Middleware::GraphqlContext

Hope this helps @gertjanjansen @tonydaly!