@grafana/alloy-pipeline-graph

中文文档
0.2.2发布于 2026/09/11Apache-2.0TypeScriptES Module近 30 天下载 1.5万

Shared Alloy pipeline graph visualization for Grafana Alloy and Fleet Management

原始使用文档
文档目录7 节
  1. Usage
  2. Click handling
  3. Optional fields
  4. Theming
  5. Development
  6. Release
  7. License

@grafana/alloy-pipeline-graph

NPM Version

Shared Alloy pipeline graph visualization for Grafana Alloy and Grafana Fleet Management.

Usage

import { PipelineGraph, type PipelineGraphData } from '@grafana/alloy-pipeline-graph';
import '@grafana/alloy-pipeline-graph/style.css';

const graph: PipelineGraphData = {
  nodes: [/* ... */],
  edges: [/* ... */],
};

// Graph-level handler — fires for every node click.
<PipelineGraph graph={graph} onNodeClick={(node) => console.log(node.id)} />

Consumers build the PipelineGraph input from their own data source:

  • Alloy — runtime component API (/api/v0/web/components)
  • Collector app — parsed Alloy config via @grafana-cloud/alloy-configurator

A runnable demo/ renders the component against several example datasets and documents the input shape — see demo/README.md.

Click handling

A node is interactive when there's a graph-level onNodeClick and/or the node carries its own onClick. Both fire on click (the per-node handler runs first), so individual nodes can override or augment the default behavior:

const graph: PipelineGraphData = {
  nodes: [
    { id: 'a', /* ... */, onClick: (node) => openDrawerFor(node) }, // per-node
  ],
  edges: [/* ... */],
};

Optional fields

  • PipelineEdge.metric — single aggregate live flow rate. When present, shown on the edge label and collapses the edge to one line.
  • PipelineEdge.signalMetrics — per-signal live rates ({ signal, value, unit? }[]). Each entry renders as its own colored line labelled with its rate, keeping the multi-signal fan-out under live data. Takes precedence over metric. Use this when a single edge carries several signals at independent rates (e.g. an OTLP receiver emitting metrics, logs and traces).
  • SignalKind.Targets — service-discovery output (target counts), colored distinctly from telemetry signals. discovery.* components infer to Targets.
  • PipelineNode.kind / parentId — expandable custom component containers.
  • PipelineNode.description / docsUrl — shown in the node's hover tooltip (docsUrl adds a "View docs" link).
  • PipelineNode.onClick — per-node click handler (see above).
  • PipelineNode.health / meta — carried on the node for consumers (e.g. in onClick); not rendered by the default node.
  • PipelineGraphProps.ui — inject Grafana Icon / Tooltip for in-app consistency.

Theming

The bundled light/dark themes mirror Grafana's GrafanaTheme2 values (colors, radius, shadows, icons), so the graph looks identical inside and outside of Grafana without depending on @grafana/ui / @grafana/data. Pass theme="light" | "dark", or a full PipelineGraphTheme object mapped from a live GrafanaTheme2 when running in-app.

Development

npm install
npm run build
npm test

Release

Releases use Changesets.

For any user-facing change, add a changeset in the PR:

npm run changeset

Pick patch, minor, or major when prompted. That choice decides the next version.

After the PR merges to main and CI passes, the release job opens/updates a release PR with the version bump and changelog. Merging that release PR publishes the package to npm.

Note: if package.json already contains a new unpublished version and there are no pending changesets, the release job will publish that version to npm.

License

Apache-2.0

版本与发布记录

@grafana/alloy-pipeline-graph 共发布 4 个版本,首次发布于 2026/06/23;过去 12 个月发布了 4 个版本。

版本发布日期距今
0.2.2latest2026/09/112 个月前
0.2.12026/07/074 个月前
0.2.02026/07/024 个月前
0.1.02026/06/234 个月前

关于 @grafana/alloy-pipeline-graph 的常见问题

@grafana/alloy-pipeline-graph 是什么?

Shared Alloy pipeline graph visualization for Grafana Alloy and Fleet Management

如何安装 @grafana/alloy-pipeline-graph?

在项目目录运行 npm install @grafana/alloy-pipeline-graph,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(^18.0.0 || ^19.0.0)、react-dom(^18.0.0 || ^19.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@grafana/alloy-pipeline-graph 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@grafana/alloy-pipeline-graph 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@grafana/alloy-pipeline-graph 可以商用吗?

@grafana/alloy-pipeline-graph 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@grafana/alloy-pipeline-graph 的下载量有多少?

根据 npm 官方下载统计,@grafana/alloy-pipeline-graph 在 2026/10/17 – 2026/11/15 这 30 天内被下载 14,647 次,日均约 488 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@grafana/alloy-pipeline-graph 还在维护吗?

最新版本 0.2.2 发布于 2026/09/11(2 个月前);至今共发布 4 个版本,其中过去 12 个月发布了 4 个;首次发布于 2026/06/23。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。