HookActivityLogger

Role in the Pipeline

HookActivityLogger runs at priority 5 — before all other hooks. It implements IHookActivityLogger and is called by the pipeline engine around each hook execution, not by the hook itself.

Log Settings Control

The logger respects the EdgeStream log settings — hook logging can be enabled/disabled and configured independently of transport logging:

// Internal (from source)
logHookStart(messageId, hookName, priority) {
  if (!getLogSettings().isHookLoggingEnabled()) return;
  getLoggingService().logHookExecution(messageId, {
    hookName, priority, status: 'start',
    message: `Starting hook: ${hookName}`,
    timestamp: new Date().toISOString(),
  });
}

logHookSuccess(messageId, hookName, priority, executionTime, context?) {
  if (!getLogSettings().isHookLoggingEnabled()) return;
  getLoggingService().logHookExecution(messageId, {
    hookName, priority, status: 'success',
    message: '✅ Hook completed successfully',
    executionTime, timestamp: new Date().toISOString(),
    ...(getLogSettings().shouldLogHookMetadata() && context && { context }),
  });
}

Installation and Usage

import { HookActivityLogger, getHookActivityLogger } from 'edge-stream-js';

// Option 1: Create a new instance
const logger = new HookActivityLogger();
server.incomingPipeline.addHook(logger);

// Option 2: Use the global singleton (recommended)
const logger = getHookActivityLogger();
server.incomingPipeline.addHook(logger);
server.outgoingPipeline.addHook(logger); // reuse same logger for both

HookActivityLogger + HooksMonitor

The HooksMonitor React component (from observability-react) subscribes to the logging service that HookActivityLogger writes to. Without HookActivityLogger registered, HooksMonitor shows no data.

// In your dev panel / admin dashboard
import { HooksMonitor } from 'observability-react';

function DevPanel() {
  return (
    <div className="dev-panel">
      <HooksMonitor
        maxEntries={200}
        filterByHookName="WorkflowEventMapperHook"
        showTimings={true}
        showEnvelopePreview={true}
      />
    </div>
  );
}