Filters

CLEAR ALL

Search Results ()

Filter Icon

Search Results ()

    All Plugins (171)

    Filter Icon

    Quick Info

    Product icon
    Product
    DevOps Velocity (HCL Accelerate)
    Plugin type icon
    Type
    plugin
    Compatibility icon
    Compatibility
    HCL DevOps Velocity version 2.0 or later
    created by icon
    Created by
    HCL Software
    Website icon
    Website
    Published Date
    March 18th, 2021
    Last Updated
    March 28th, 2024

    Description

    The HCL DevOps Velocity bottleneck detection plugin monitors, detects, and alerts the user to the existence of bottlenecks in a value stream. A value stream bottleneck is a restriction in the local throughput that limits the global throughput of a system. The plugin process uses work item stage-change data in concert with three individual algorithms in order to detect the presence of a bottleneck. Each individual algorithm monitors a value stream for the presence of a specific type of bottleneck. Detected bottlenecks are written to the metrics collection in the form of a bottleneck location (value stream and stage), detection message for display, and measure of bottleneck severity used for display prioritization.

    Quick Info

    Product icon
    Product
    DevOps Velocity (HCL Accelerate)
    Plugin type icon
    Type
    plugin
    Compatibility icon
    Compatibility
    HCL DevOps Velocity version 2.0 or later
    created by icon
    Created by
    HCL Software
    Website icon
    Website
    Published Date
    March 18th, 2021
    Last Updated
    March 28th, 2024

    ucv-ext-bottleneck-detection:1.0.3.tar

    Uploaded: 13-Mar-2024 13:05

    Pull Command

    docker pull hclcr.io/accelerate/ucv-ext-bottleneck-detection:1.0.3

    Release Notes

  • Removed Manual User Access Key : From current version onwards this plugin will only support Auto Generated User Access Key feature of HCL Accelerate.
  • Minor Enhancement: We can now identify bottlenecks for individual value streams, resolving the issue of occasionally encountering failures when attempting to identify bottlenecks for all value streams simultaneously.
  • ucv-ext-bottleneck-detection:1.0.2.tar

    Uploaded: 13-Mar-2024 12:59

    ucv-ext-bottleneck-detection:1.0.1.tar

    Uploaded: 08-Feb-2021 07:32

    Summary

    The Bottleneck Detection plugin monitors, detects, and provides an alert when bottlenecks are detected in a value stream. A value stream bottleneck is a restriction in the local throughput that limits the global throughput of a system.

    The plugin uses three algorithms each detecting a different type of bottlenecks:

    • Dominant stage bottleneck – one stage in a value stream has a time-in-stage value greater than or equal to the sum of the time-in-stages of all other stages in that value stream
    • Batching bottleneck – work items exit a given stage in short time intervals separated by large intervals with no associated activity
    • Inflow/outflow asymmetry bottleneck – unusually large difference of work items flowing into and out of a stage on a given day

    The plugin runs automatically every 24 hours after a manually started run.

    At runtime, records for all defined value streams are processed through each bottleneck type algorithm. Bottleneck detection records are returned for each value stream. A value stream can have multiple bottleneck detection records created during a given run, or it may have none. If multiple bottlenecks are found for a given run, only the highest severity bottleneck is displayed. However, all detection records are logged in the database. You can view detected bottlenecks on the All Value Streams page.

    For additional information, see Bottleneck detection topic in the product documentation.

    History

    The following table describes the changes made in each plugin version.

    Plugin history details
    Version Description
    1.0.2 Minor updates
    1.0.1 Initial release

    Usage

    To use the Bottleneck plugin, the plugin must be loaded and an instance created before you can configure the plugin integration. You define configuration properties in the user interface or in a JSON file.

    Integration type

    The Bottleneck Detection plugin supports scheduled events integration which are listed in the following table.

    Scheduled events
    Name Description
    execute Calculate bottlenecks.

    Integration

    There are two methods to integrate the plugin:

    • Using the user interface
    • Using a JSON file

    The tables in the Configuration properties topic describe the properties used to define the integration.

    Using the user interface

    1. From the Plugins page, click Settings > Integrations > Plugins.
    2. Under the Action column for the plugin, click Add Integration.
    3. On the Add Integration page enter values for the fields used to configure the integration and define communication.
    4. Click Save.

    Using a JSON file

    The JSON file contains the information for creating a value stream. Within the JSON file is a section for integrations. It is in this section that plugin properties can be defined.

    1. From a value stream page, download the value stream map. The value stream map is a JSON file used to define integrations.
    2. Edit the JSON file to include the plugin configuration properties.
    3. Save and upload the JSON file. This replaces the current JSON file with the new content.
    4. View the new integration on the Integrations page.

    Configuration Properties

    The following tables describe the properties used to configure the integration. Each table contains the field name when using the user interface and the property name when using a JSON file.

    • The General Configuration Properties table describes configuration properties used by all plugin integrations.
    • The Bottleneck Detection Configuration Properties table describes the configuration properties that define the connection and communications with the Bottleneck Detection server. When using the JSON method to integrate the plugin these properties are coded within the properties configuration property.

    Some properties might not be displayed in the user interface, to see all properties enable the Show Hidden Properties field.

    General Configuration properties
    Name Description Required Property Name
    NA The version of the plugin that you want to use. To view available versions, click the Version History tab. If a value is not specified, the version named latest is used. No image
    Integration Name An assigned name to the value stream. Yes name
    Logging Level The level of Log4j messages to display in the log file. Valid values are: all, debug, info, warn, error, fatal, off, and trace. No loggingLevel
    NA List of plugin configuration properties used to connect and communicate with the HCL DevOps Velocity server. Enclose the properties within braces. Yes properties
    The name of the tenant. Yes tenant_id
    NA Unique identifier assigned to the plugin. The value for the Bottleneck Detection plugin is ucv-ext-bottleneck-detection Yes type

    Bottleneck Detection Configuration Properties
    Name Type Description Required Property Name
    UCV User Access Key Secure The user access key used to authenticate with the HCL DevOps Velocity server. Yes ucvKey
    Workflow Id String Enter the workflow ID for which you need to detect the bottleneck.You can get workflowId for any valuestream from the URL of the valuestream. No workflowId

    JSON code sample

    The following sample code can be used as a template to define the integration within the JSON file for a value stream. Copy and paste the template into the JSON file Integration section and make the appropriate changes.

    
    "integrations": [
        {
          "type": "ucv-ext-bottleneck-detection",
          "name": "Bottlenecks",
          "tenant_id": "5ade13625558f2c6688d15ce",
          "ucvKey": "key
          "logginglevel": "info",
          "properties": {
                    ],
                  }
        }
      ]