apache / apache/beam

PTransform application identifier(name) documentation.

Open
#18,384 1 comment 0 reactions 0 assignees View on GitHub
core improvement java P3 python website
Dominant language
Java
Stars
8.7k
Forks
4.7k
Avg merge
2d 2h
Merged PRs (30d)
205

Description

Add documentation around the user supplied/automatically created identifier (name) of the application of a `PTransform` within the pipeline.

Make sure to relate to how it is constructed when the application is within a composite transform.

Relate to how this name affects metrics aggregation and metrics querying.

Imported from Jira [BEAM-2035](https://issues.apache.org/jira/browse/BEAM-2035). Original Jira may contain additional context.
Reported by: aviemzur.

Contributor guide

Open the contributing guide

Research direction

Start by locating the existing PTransform documentation and the documentation for metrics aggregation and querying. Trace how user-supplied or automatic application identifiers are formed inside composite transforms, then document the naming rules and their effect on metrics.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.