backstage/plugins/kafka

Kafka Plugin

Setup

1. Run:

yarn add @backstage/plugin-kafka @backstage/plugin-kafka-backend

2. Add the plugin backend:

In a new file named kafka.ts under backend/src/plugins:

import { createRouter } from '@backstage/plugin-kafka-backend';
import { PluginEnvironment } from '../types';

export default async function createPlugin({
  logger,
  config,
}: PluginEnvironment) {
  return await createRouter({ logger, config });
}

And then add to packages/backend/src/index.ts:

// ...
import kafka from './plugins/kafka';
// ...
async function main() {
  // ...
  const kafkaEnv = useHotMemoize(module, () => createEnv('kafka'));
  // ...

  const apiRouter = Router();
  // ...
  apiRouter.use('/kafka', await kafka(kafkaEnv));
  // ...

3. Add the plugin frontend to packages/app/src/plugin.ts:

export { plugin as Kafka } from '@backstage/plugin-kafka';

4. Register the plugin frontend router in packages/app/src/components/catalog/EntityPage.tsx:

import { Router as KafkaRouter } from '@backstage/plugin-kafka';

// Then, somewhere inside <EntityPageLayout>

<EntityPageLayout.Content
  path="/kafka/*"
  title="Kafka"
  element={<KafkaRouter entity={entity} />}
/>;

5. Add broker configs for the backend in your app-config.yaml:

kafka:
  clientId: backstage
  clusters:
    - name: cluster-name
      brokers:
        - localhost:9092

6. Add kafka.apache.org/consumer-groups annotation to your services:

apiVersion: backstage.io/v1alpha1
kind: Component
metadata:
  # ...
  annotations:
    kafka.apache.org/consumer-groups: cluster-name/consumer-group-name
spec:
  type: service

Features

• List topics offsets and consumer group offsets for configured services.