Skip to content

Bug: Streaming example does not work. Docs not in sync with API #2486

@henrikschristensen

Description

@henrikschristensen

Which package(s) does this bug affect?

  • Create Plugin
  • Sign Plugin
  • Plugin E2E
  • Plugin Meta Extractor
  • Plugin ESLint Rules

Package versions

npx @grafana/create-plugin@latest version
6.10.2

What happened?

I am trying to follow this example document. https://grafana.com/developers/plugin-tools/tutorials/build-a-streaming-data-source-plugin.
I have 2 issues.

  • First. When implementing the example it does not work. Frontend code fails with "Query error
    Streaming channel error: invalid channel address"

  • Second is that the example code in the document does not compile. Type LiveChannelAddress seems to have been changed. Property namespace in the example does not exist. There is a new property "stream".

What you expected to happen

According to the example document a datasource with streaming capabilities should be working in the loaded grafana.

How to reproduce it (as minimally and precisely as possible)

  1. Ubuntu running in wsl2
    Just follow the exanple doc.

Environment

System:
    OS: Linux 6.6 Ubuntu 24.04.4 LTS 24.04.4 LTS (Noble Numbat)
    CPU: (16) x64 AMD Ryzen 7 PRO 4750U with Radeon Graphics
    Memory: 14.20 GB / 15.23 GB
    Container: Yes
    Shell: 5.2.21 - /bin/bash
  Binaries:
    Node: 24.13.0 - /home/ubuntu/.nvm/versions/node/v24.13.0/bin/node
    npm: 11.6.2 - /home/ubuntu/.nvm/versions/node/v24.13.0/bin/npm
  npmPackages:
    @grafana/data: ^12.3.2 => 12.4.0
    @grafana/eslint-config: ^9.0.0 => 9.0.0
    @grafana/i18n: ^12.3.2 => 12.4.0
    @grafana/plugin-e2e: ^3.3.3 => 3.4.0
    @grafana/runtime: ^12.3.2 => 12.4.0
    @grafana/schema: ^12.3.2 => 12.4.0
    @grafana/tsconfig: ^2.0.1 => 2.0.1
    @grafana/ui: ^12.3.2 => 12.4.0

Additional context

No response

Metadata

Metadata

Assignees

Labels

no-changelogDon't include in changelog and version calculationstype/docsChanges only affect the documentation

Type

No type
No fields configured for issues without a type.

Projects

Status

🚀 Shipped

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions