Thank you Jesse for the guidance.
I have introduced in my code higher level listener interface to simplify
the usage of the GraphListener API. See skeleton of the listener API below.
@Jeff thanks, I am sending you a direct message to organise a quick call.
Cyrile
----
public interface PipelineListener {
@Nonnull
static List<PipelineListener> all() {
return ExtensionList.lookup(PipelineListener.class);
}
/**
* Just before the pipeline starts
*/
void onStartPipeline(@Nonnull FlowNode node, @Nonnull WorkflowRun run);
/**
* Just before the `stage`step starts
*/
void onStartStageStep(@Nonnull StepStartNode stepStartNode, @Nonnull String
stageName, @Nonnull WorkflowRun run);
/**
* Just after the `stage` step ends
*/
void onAfterEndStageStep(@Nonnull StepEndNode stageStepEndNode, @Nonnull
String stageName, @Nonnull WorkflowRun run);
/**
* Just before the `parallel` branch starts
*/
void onStartParallelStepBranch(@Nonnull StepStartNode stepStartNode,
@Nonnull String branchName, @Nonnull WorkflowRun run);
/**
* Just before the `parallel` branch ends
*/
void onEndParallelStepBranch(@Nonnull StepEndNode stepStepNode, @Nonnull
String branchName, @Nonnull WorkflowRun run);
/**
* Just before the atomic step starts
*/
void onAtomicStep(@Nonnull StepAtomNode node, @Nonnull WorkflowRun run);
/**
* Just after the atomic step
*/
void onAfterAtomicStep(@Nonnull StepAtomNode stepAtomNode, @Nonnull
WorkflowRun run);
/**
* Just after the pipeline ends
*/
void onEndPipeline(@Nonnull FlowNode node, @Nonnull WorkflowRun run);
}
----
On Wednesday, January 13, 2021 at 7:35:46 PM UTC+1 [email protected] wrote:
> Happy to have a chat. What time zone are you in? I'm on the US West Coast
> (PST). I'm not sure whether anyone else in the community is interested, but
> replying to the group just in case.
>
> On Wed, Jan 13, 2021 at 1:26 AM 'Cyrille Le Clerc' via Jenkins Developers <
> [email protected]> wrote:
>
>> Hello Jeff,
>>
>> It's a great idea to include the tracing and the OpenTelemetry
>> capabilities in the "Job and Stage monitoring plugin".
>>
>> Would you have a moment to have a video conversation to align on the
>> vision and to discuss the way to move forward?
>>
>> Cyrille
>>
>> On Tuesday, January 12, 2021 at 5:13:11 PM UTC+1 [email protected] wrote:
>>
>>> I'm the author of the "Job and Stage monitoring plugin"
>>>
>>> Have you considered extending that plugin? I don't entirely understand
>>> what you're trying to accomplish, but to the extent it overlaps with your
>>> proposed plugin, it's probably better for the community not to have two
>>> similar plugins. Most users aren't going to understand the differences
>>> between two similar plugins, which is confusing and frustrating.
>>>
>>> The "Job and Stage monitoring plugin" watches jobs, and allows code to
>>> take arbitrary actions at the end of each step in a job, and also at the
>>> end of the job. Said code can either be hosted in the JSM plugin, or an
>>> entirely separate plugin.
>>>
>>> On Tue, Jan 12, 2021 at 4:14 AM Andrey Babushkin <[email protected]>
>>> wrote:
>>>
>>>>
>>>> You can take a look at Job and Stage monitoring plugin (
>>>> https://github.com/jenkinsci/github-autostatus-plugin). I think it
>>>> does the thing you're looking for.
>>>> On Tuesday, January 12, 2021 at 4:50:23 AM UTC+3 Mark Waite wrote:
>>>>
>>>>> On Mon, Jan 11, 2021 at 6:24 PM 'Cyrille Le Clerc' via Jenkins
>>>>> Developers <[email protected]> wrote:
>>>>>
>>>>>> Dear community,
>>>>>>
>>>>>> *Context: *
>>>>>> I'm trying to implement an OpenTelemetry instrumentation of Jenkins,
>>>>>> starting injecting distributed traces in job executions. See
>>>>>> https://github.com/cyrille-leclerc/opentelemetry-plugin
>>>>>>
>>>>>> *Question: *
>>>>>> *What is the recommended way to listen to the end of the execution of
>>>>>> a step and to collect its result?*
>>>>>> I would like to listen the end of execution of `stage`and `git` steps
>>>>>> to end a trace span reporting the result of the step.
>>>>>>
>>>>>> I found the `GraphListener#onNewHead(FlowNode)` API and I identify
>>>>>> the end of stage steps with `StepEndNode` containing a whose
>>>>>> descriptor
>>>>>> is a `StageStep.DescriptorImpl` but
>>>>>>
>>>>>> - I am not clear on if I should track the `StepEndNode`
>>>>>> containing a `LabelAction` or an `ArgumentsAction`
>>>>>> - On none of the StepEndNode give me access to the error thrown
>>>>>> during the execution to indicate a failure, `StepEndNode#getError()`
>>>>>> and
>>>>>> `StepEndNode.getExecution.getCauseOfFailure()` return null
>>>>>> during `GraphListener#onNewHead(FlowNode)`
>>>>>>
>>>>>> I'm wondering if I have to add a `BodyExecutionCallback` to the `
>>>>>> CpsBodyInvoker` but I didn't find an API to do this implementing a
>>>>>> listener of the pipeline executions.
>>>>>>
>>>>>> I have a similar request for `git` steps that don't even have a
>>>>>> `StepEndNode`, how can I intercept the end of execution and the
>>>>>> result/error of the execution of a `git` step.
>>>>>>
>>>>>>
>>>>>
>>>>> I don't know the answer to your listener question. This is probably
>>>>> not what you want to hear, but I think that you should focus on the
>>>>> checkout step rather than the git step. Per the git step documentation:
>>>>>
>>>>> More advanced checkout operations require the checkout step rather
>>>>> than the git step.
>>>>>
>>>>> The git step is a simplified shorthand for a subset of the more
>>>>> powerful checkout step:
>>>>>
>>>>> checkout([$class: 'GitSCM', branches: [[name: '*/master']],
>>>>> userRemoteConfigs: [[url: 'http://git-server/user/repository.git']]])
>>>>>
>>>>>
>>>>>
>>>>>
>>>>>> I hope my question is detailed enough.
>>>>>>
>>>>>> Cyrille
>>>>>>
>>>>>> --
>>>>>> You received this message because you are subscribed to the Google
>>>>>> Groups "Jenkins Developers" group.
>>>>>> To unsubscribe from this group and stop receiving emails from it,
>>>>>> send an email to [email protected].
>>>>>> To view this discussion on the web visit
>>>>>> https://groups.google.com/d/msgid/jenkinsci-dev/db5376b1-3888-46f0-9429-9b34e3940ed9n%40googlegroups.com
>>>>>>
>>>>>> <https://groups.google.com/d/msgid/jenkinsci-dev/db5376b1-3888-46f0-9429-9b34e3940ed9n%40googlegroups.com?utm_medium=email&utm_source=footer>
>>>>>> .
>>>>>>
>>>>> --
>>>> You received this message because you are subscribed to the Google
>>>> Groups "Jenkins Developers" group.
>>>> To unsubscribe from this group and stop receiving emails from it, send
>>>> an email to [email protected].
>>>>
>>> To view this discussion on the web visit
>>>> https://groups.google.com/d/msgid/jenkinsci-dev/a1012b64-1979-47a5-9646-832e21376146n%40googlegroups.com
>>>>
>>>> <https://groups.google.com/d/msgid/jenkinsci-dev/a1012b64-1979-47a5-9646-832e21376146n%40googlegroups.com?utm_medium=email&utm_source=footer>
>>>> .
>>>>
>>> --
>> You received this message because you are subscribed to the Google Groups
>> "Jenkins Developers" group.
>> To unsubscribe from this group and stop receiving emails from it, send an
>> email to [email protected].
>>
> To view this discussion on the web visit
>> https://groups.google.com/d/msgid/jenkinsci-dev/8be42453-51dd-40ae-bce4-fe543a6271a6n%40googlegroups.com
>>
>> <https://groups.google.com/d/msgid/jenkinsci-dev/8be42453-51dd-40ae-bce4-fe543a6271a6n%40googlegroups.com?utm_medium=email&utm_source=footer>
>> .
>>
>
--
You received this message because you are subscribed to the Google Groups
"Jenkins Developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/jenkinsci-dev/23d8e12a-148c-4eab-8c2e-18b1bce46375n%40googlegroups.com.
