Files

T

dependabot[bot] e5327abaa3 build(deps): bump @testing-library/react-hooks from 3.4.2 to 7.0.2

Bumps [@testing-library/react-hooks](https://github.com/testing-library/react-hooks-testing-library) from 3.4.2 to 7.0.2.
- [Release notes](https://github.com/testing-library/react-hooks-testing-library/releases)
- [Changelog](https://github.com/testing-library/react-hooks-testing-library/blob/main/CHANGELOG.md)
- [Commits](https://github.com/testing-library/react-hooks-testing-library/compare/v3.4.2...v7.0.2)

---
updated-dependencies:
- dependency-name: "@testing-library/react-hooks"
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>

2021-09-28 13:01:24 +02:00

dev

Update copyright headers

2021-06-18 20:26:42 +02:00

src

Merge pull request #7181 from backstage/rugvip/descriptions

2021-09-15 17:25:27 +02:00

.eslintrc.js

Added a scaffolded new plugin

2020-12-21 13:21:48 +02:00

api-report.md

packages,plugins: add package documentation

2021-09-14 18:47:53 +02:00

CHANGELOG.md

Version Packages

2021-09-23 10:01:17 +00:00

package.json

build(deps): bump @testing-library/react-hooks from 3.4.2 to 7.0.2

2021-09-28 13:01:24 +02:00

README.md

Minor composability etc docs changes

2021-05-02 22:13:05 +02:00

README.md

Kafka Plugin

Setup

Run:

# From your Backstage root directory
yarn --cwd packages/app add @backstage/plugin-kafka
yarn --cwd packages/backend add @backstage/plugin-kafka-backend

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:

// In packages/backend/src/index.ts
import kafka from './plugins/kafka';
// ...
async function main() {
  // ...
  const kafkaEnv = useHotMemoize(module, () => createEnv('kafka'));
  // ...
  apiRouter.use('/kafka', await kafka(kafkaEnv));

Add the plugin as a tab to your service entities:

// In packages/app/src/components/catalog/EntityPage.tsx
import { EntityKafkaContent } from '@backstage/plugin-kafka';

const serviceEntityPage = (
  <EntityLayout>
    {/* other tabs... */}
    <EntityLayout.Route path="/kafka" title="Kafka">
      <EntityKafkaContent />
    </EntityLayout.Route>

Add broker configs for the backend in your app-config.yaml (see kafka-backend for more options):

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

Add the 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.