Uploaded image for project: 'Jenkins'
  1. Jenkins
  2. JENKINS-28293

Display more information about Pipeline steps

    Details

    • Type: Improvement
    • Status: Resolved (View Workflow)
    • Priority: Minor
    • Resolution: Duplicate
    • Component/s: workflow-job-plugin
    • Labels:
      None
    • Environment:
      Workflow 1.6
    • Similar Issues:

      Description

      The printed strings from Workflow Steps should be more informative. Currently, most steps display very generic messages (with the exception of Loaded Script). This applies both to the Console Output as well as the Running Steps page.

      At minimum, all steps should support a 'label' parameter, which if set should display a custom string instead of the generic messages.

      It would also be useful if more steps displayed their arguments in their generic message like Load Script includes the filename.

        Attachments

          Issue Links

            Activity

            Hide
            jglick Jesse Glick added a comment -

            Partly covered by JENKINS-26107.

            Show
            jglick Jesse Glick added a comment - Partly covered by JENKINS-26107 .
            Hide
            deepchip Martin d'Anjou added a comment -

            Does this issue also intent to cover the build page when it shows the outcome of prompting the user with the input step, i.e. "This was approved by user ..."? I have several approvals in a single build, and I can't tell which is which from the list as they all say the same.

            Show
            deepchip Martin d'Anjou added a comment - Does this issue also intent to cover the build page when it shows the outcome of prompting the user with the input step, i.e. "This was approved by user ..."? I have several approvals in a single build, and I can't tell which is which from the list as they all say the same.
            Hide
            jglick Jesse Glick added a comment -

            Martin d'Anjou no that would be completely unrelated.

            Show
            jglick Jesse Glick added a comment - Martin d'Anjou no that would be completely unrelated.
            Hide
            jglick Jesse Glick added a comment -

            Need to revisit. Might have been covered by JENKINS-30088.

            Show
            jglick Jesse Glick added a comment - Need to revisit. Might have been covered by JENKINS-30088 .
            Hide
            jglick Jesse Glick added a comment -

            Would need JENKINS-31582 to capture step arguments.

            Show
            jglick Jesse Glick added a comment - Would need JENKINS-31582 to capture step arguments.
            Hide
            jglick Jesse Glick added a comment -

            Since there are already labels coming from many steps, and JENKINS-26107 allows you to easily add more labels, I think the only thing really missing here is a way to look at step parameters.

            Show
            jglick Jesse Glick added a comment - Since there are already labels coming from many steps, and JENKINS-26107 allows you to easily add more labels, I think the only thing really missing here is a way to look at step parameters.
            Hide
            battika Attila Strba added a comment -

            Is this feature in the Pipeline 2.2 now implemented? Although JENKINS-26107 is closed I see no possibility to assign the sh a label and it just appears as a " Shell Script" in the pipeline view. Any idea how to achieve this?

            Show
            battika Attila Strba added a comment - Is this feature in the Pipeline 2.2 now implemented? Although JENKINS-26107 is closed I see no possibility to assign the sh a label and it just appears as a " Shell Script" in the pipeline view. Any idea how to achieve this?
            Hide
            battika Attila Strba added a comment - - edited

            Our jenkins pipelines are quite complex, running several parallel stuff, and we have pretty hard time to analyse which step of the pipeline is doing what, or where to look for console log. BlueOcean gives a better visualisation but since it is somehow unstable on our server and runs very slow currently it is not usable for us.

            It would be amazing if it would be possible to add a comment to the most relevant pipeline steps. It would make tracking down problems easier. Just an example a mocked up pipeliene step view:

            Jesse Glick What do you think about this? Or is there any other possibilities to provide information in the pipeline stepps view? Thank you very much for the help.

            Show
            battika Attila Strba added a comment - - edited Our jenkins pipelines are quite complex, running several parallel stuff, and we have pretty hard time to analyse which step of the pipeline is doing what, or where to look for console log. BlueOcean gives a better visualisation but since it is somehow unstable on our server and runs very slow currently it is not usable for us. It would be amazing if it would be possible to add a comment to the most relevant pipeline steps. It would make tracking down problems easier. Just an example a mocked up pipeliene step view: Jesse Glick What do you think about this? Or is there any other possibilities to provide information in the pipeline stepps view? Thank you very much for the help.
            Hide
            jglick Jesse Glick added a comment -

            stage suffices for most of that.

            Show
            jglick Jesse Glick added a comment - stage suffices for most of that.
            Hide
            battika Attila Strba added a comment - - edited

            thank you for your response...
            Jesse Glick so you mean I should pack each call to sh to stage?
            but not all things can go to separate stages especially as we are using parallel steps and there it was written we shouldn't use stages under parallel ....

            also stage has the possibility to show several steps of loggs, I guess it would highly improove the readability if there would be a possibility to comment those steps...

            Show
            battika Attila Strba added a comment - - edited thank you for your response... Jesse Glick so you mean I should pack each call to sh to stage? but not all things can go to separate stages especially as we are using parallel steps and there it was written we shouldn't use stages under parallel .... also stage has the possibility to show several steps of loggs, I guess it would highly improove the readability if there would be a possibility to comment those steps...
            Hide
            jglick Jesse Glick added a comment -

            so you mean I should pack each call to sh to stage?

            Interesting ones, yes, or where appropriate multiple low-level steps in one stage, or nest them as needed etc.

            it was written we shouldn't use stages under parallel

            Applies only to deprecated stage. stage taking a block may be used freely inside parallel.

            Show
            jglick Jesse Glick added a comment - so you mean I should pack each call to sh to stage ? Interesting ones, yes, or where appropriate multiple low-level steps in one stage , or nest them as needed etc. it was written we shouldn't use stages under parallel Applies only to deprecated stage . stage taking a block may be used freely inside parallel .
            Hide
            mbadran mohamed badran added a comment -

            Using stages as well would give you very long pipeline view which is so bad specially when you've large number of sh calls

            Show
            mbadran mohamed badran added a comment - Using stages as well would give you very long pipeline view which is so bad specially when you've large number of sh calls
            Hide
            jglick Jesse Glick added a comment -

            Sam Van Oort designed the current version of the Stage View plugin to show all stage steps in the build. My original intention was for it to show only top-level stage steps. At any rate, no one is expecting to update this plugin to show a more refined view; perhaps Blue Ocean will (TBD). For now, the simple built-in Pipeline Steps is the only full-fidelity display.

            Show
            jglick Jesse Glick added a comment - Sam Van Oort designed the current version of the Stage View plugin to show all stage steps in the build. My original intention was for it to show only top-level stage steps. At any rate, no one is expecting to update this plugin to show a more refined view; perhaps Blue Ocean will (TBD). For now, the simple built-in Pipeline Steps is the only full-fidelity display.
            Hide
            svanoort Sam Van Oort added a comment -

            Attila Bánfi I've got a concrete proposal with JENKINS-26522 that would allow adding metadata to steps (for example custom labelling), and includes a PR to enable the functionality – currently waiting on Jesse Glick to approve it. That would provide the precursor to what you describe, though it would require additional work to record the additional information to steps and display it.

            It's quite clear to me that JENKINS-26107 doesn't help your needs really, unless visualization support for nested stages is added. CC James Dumay and Vivek Pandey since it looks like it might be coming up again.

            Jesse Glick I'm not really sure what you're going on about here, but it sounds like you have some sort of grievance that wasn't voiced previously when design for JENKINS-26107 was happening – I'd encourage you to reach out to talk directly rather than airing it in public JIRAs.

            Show
            svanoort Sam Van Oort added a comment - Attila Bánfi I've got a concrete proposal with JENKINS-26522 that would allow adding metadata to steps (for example custom labelling), and includes a PR to enable the functionality – currently waiting on Jesse Glick to approve it. That would provide the precursor to what you describe, though it would require additional work to record the additional information to steps and display it. It's quite clear to me that JENKINS-26107 doesn't help your needs really, unless visualization support for nested stages is added. CC James Dumay and Vivek Pandey since it looks like it might be coming up again. Jesse Glick I'm not really sure what you're going on about here, but it sounds like you have some sort of grievance that wasn't voiced previously when design for JENKINS-26107 was happening – I'd encourage you to reach out to talk directly rather than airing it in public JIRAs.
            Hide
            jamesdumay James Dumay added a comment -
            Show
            jamesdumay James Dumay added a comment - Sam Van Oort ack
            Hide
            battika Attila Strba added a comment -

            Sam Van Oort Thank you for the comprehensive answer. The JENKINS-26522 looks quite good and is exactly what would help us. I still wonder thet currently there was no need for more detail for analysis. Prehaps our pipeline job is too complex, but it is due to the complexity of our project.

            If there is way to drive this forward or anyway I could help just let me know...
            I see the future of jenkins in pipelines.... but BlueOcean to come is yet too far away for us....

            Show
            battika Attila Strba added a comment - Sam Van Oort Thank you for the comprehensive answer. The JENKINS-26522 looks quite good and is exactly what would help us. I still wonder thet currently there was no need for more detail for analysis. Prehaps our pipeline job is too complex, but it is due to the complexity of our project. If there is way to drive this forward or anyway I could help just let me know... I see the future of jenkins in pipelines.... but BlueOcean to come is yet too far away for us....
            Hide
            jamesdumay James Dumay added a comment -

            This is duplicated in JENKINS-37324

            Show
            jamesdumay James Dumay added a comment - This is duplicated in JENKINS-37324

              People

              • Assignee:
                jglick Jesse Glick
                Reporter:
                sumdumgai A C
              • Votes:
                16 Vote for this issue
                Watchers:
                22 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: