new-plugin

Generate complete SkyWalking Python plugin scaffolding with tests and docker-compose.

218|112|Updated May 5, 2020
One-click install
npx skills add https://github.com/apache/skywalking-python --skill new-plugin-apache
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: new-plugin
Source: https://github.com/apache/skywalking-python/tree/main/.claude/skills/new-plugin
Command: npx skills add https://github.com/apache/skywalking-python --skill new-plugin-apache

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This SKILL solves the tedious, multi-file scaffolding required to add a new SkyWalking Python instrumentation plugin by automating code, tests, and test infrastructure.

Core Features & Use Cases

  • Automated plugin module skeleton creation (skywalking/plugins/sw_<name>.py) with license header.
  • New Component enum entry guidance and scaffolding for the plugin.
  • Test scaffolding: creates tests/plugin structure with data/http/web as appropriate, plus docker-compose.yml and provider/consumer services.
  • Docs and tooling: updates pyproject, regenerates docs, and runs lint.
  • End-to-end readiness: produces an example expected data layout for integration tests.

Quick Start

Generate a complete scaffold for a SkyWalking Python instrumentation plugin by specifying a library and the instrumentation type.

Frequently Asked Questions about new-plugin

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I scaffold a new SkyWalking Python instrumentation plugin?

To scaffold a SkyWalking Python instrumentation plugin, this tool generates the complete plugin module, tests, docker-compose harness, and expected data layout. It ensures compliance with repository conventions by creating the file skeleton and component enum entry.

What is included in SkyWalking Python plugin test scaffolding?

SkyWalking Python plugin test scaffolding includes a tests/plugin directory structure with data, http, and web subdirectories as appropriate, plus a docker-compose.yml file with provider and consumer services for integration testing.

Can I generate scaffolding for different types of SkyWalking Python plugins?

Yes, plugin scaffolding applies to instrumentation across entry and exit spans for web, HTTP, database, cache, MQ, and RPC plugins. You specify a library and instrumentation type to generate the appropriate structure.

How do I add a new component enum entry for a SkyWalking Python plugin?

Adding a new component enum entry for a SkyWalking Python plugin is handled automatically during scaffolding. The generation process includes guidance and file updates needed to register the new component correctly.

Does SkyWalking Python plugin scaffolding update pyproject and run lint?

Yes, SkyWalking Python plugin scaffolding updates pyproject configurations, regenerates documentation, and runs lint checks. This ensures the newly generated plugin files meet repository formatting and dependency standards.

What is the best way to automate SkyWalking Python plugin creation?

Automating SkyWalking Python plugin creation is best handled by using this scaffolding tool to generate the full multi-file structure. It delivers a repeatable workflow that produces the plugin module, test harness, and expected data layout end-to-end.