Contribute

  • Monitoring Tools
  • Contribute
  • Authors
  • Cite Us

    • It is possible to add or update the monitoring tools displayed.

    The source for all the information about the monitoring tools is hosted on GitHub at udevops-monitoring-tools.github.io. Here are the steps needed to contribute to the GitHub repository.

    Step 1: Fork

    Fork the project on GitHub and clone the fork made locally from the 'main' branch. 

    git clone https://github.com/udevops-monitoring-tools/udevops-monitoring-tools.github.io

    Step 2: Branch

    Create a new branch so it is easier to avoid conflicts and issues when making a contribution. 

    git checkout -b my-branch -t origin/main

    Step 3: Modify

    Here is a JSON file with all the monitoring tools included so far. To add a monitoring tool to the web view, add it to the end of the file and try to follow the format of the other tools so the filtering works properly. Each tool has several JSON key/value pairs that give information about the tool. It is important to understand what each key means, so below are the relevant keys and their meaning:

      "ID": The internally used ID of the tool
      "Name": The name of the tool
      "Provider": Organization/authors that developed the tool
      "FIRST_RELEASE": Date of the first available release
      "YEAR": Date of the latest available release
      "OPEN_SOURCE": Whether the tool’s sources are available openly
      "TARGET": The target system to monitor
      "DATA": List of formats to export monitored data (e.g., JSON, CSV)
      "VISUALIZATION": The visualization features offered by the tool
      "TECHNOLOGIES": The language(s) the tool is programmed with
      "INTEGRATION": Required and integrable tools
      "ASSUMPTIONS": Properties that the monitored system should have
      "USER_METRICS": High level, user-oriented metrics (e.g., failure, health)
      "SYSTEM_METRICS": Low level, system-oriented metrics (e.g., cpu, memory)
      "TRACING": Whether the tool support requests tracing
      "EVENTS_LOGGING": Whether the tool support event/failures logging
      "TARGET_QUALITY_ATTRIBUTE": The quality attribute(s) targeted by the tools
      "MONITORING_PATTERN": Monitoring patterns implemented by the tool
      "MONITORING_GRANULARITY": The granularity of the monitored system
      "MONITORING_PRACTICES": Monitoring practices adopted by the tool
      "INSTRUMENTATION": Information about what instrumentation is required
      "INTEGRATION_WITH_TESTING": Whether the tool support testing
      "ADDRESSED_CHALLENGES": Below are the meanings of each challenge ID that can be used
      • MC1: Collection of monitoring metrics data and logs from containers
      • MC2: Distributed tracing
      • MC3: Many components to monitor (complexity)
      • MC4: Performance monitoring
      • MC5: Analyzing the collected data
      • MC6: Failure zone detection
      • MC7: Availability of the monitoring tools
      • MC8: Monitoring of application running in containers
      • MC9: Maintaining monitoring infrastructures
      "Link": Link to the tool

    Step 4: Commit

    Once done modifying or adding to the repository, commit the changes. 

    git commit

    Step 5: Push

    Push the commits made to the repository, creating a pull request to the main branch. 

    git push origin my-branch

    Step 6: Discuss

    Ideally, a discussion will follow up about the contributions made with other authors or contributors.

    Step 7: Merge

    Merge the pull request so that the final version of the contribution is included in the monitoring tools.