This repository aims to be a comprehensive source of information on performance issues. The goal is to provide a single place for various performance analysis system to have a uniformed way to describe common performance problems and to provide their solutions.

Whether you're working on a web application, mobile app, or a system, performance is a crucial aspect to consider. The repository will include issues related to CPU usage, memory usage, network latency, and more. Each issue will be accompanied by a detailed explanation of what it is, why it's important, and possible improvements.

This is an open source repository and we welcome contributions from the community. If you have encountered a performance issue and have a solution, please consider submitting a pull request to add it to the repository. The more knowledge we share, the more we can improve the performance of our applications and systems.

• Assuming there's a performance issue you want to share with someone, instead of describing it, share a url like this (click on it to see it live):

  • https://purple-beach-00e7e341e.2.azurestaticapps.net/Issues/032a1d51-428a-4b16-bf75-ebff5e1755d2?spec-version=1.0.0-alpha9

    • Alright, it will be a stable/custom domain name;
    • But then the key information would be:
      • Issue permanent id: 032a1d51-428a-4b16-bf75-ebff5e1755d2
      • In registry spec of version: 1.0.0-alpha9

  • On the other end, we will get:

• If you are building a performance issue detecting system, consider bake in the permanent id and the version into the output, you don't have to worry about writing descriptions or recommendations, help docs for the issue.

• You could access the issues through the RESTful API. For example:

  • https://opiapi.delightfulrock-a140dca6.westus.azurecontainerapps.io/issues/032a1d51-428a-4b16-bf75-ebff5e1755d2?spec-version=1.0.0-alpha9
    • You will get a json representative of the same issue.
    • Now, it can be render to a UI by your choice.

• To contribute to the collection of the performance issues (the registry), submit a PR for this registry file.

  • You could use the Web UI to generate the json: https://aka.ms/opiweb.

• Consistent performance issue descriptions

  • Index the performance issues and provide consistent language to describe a performance issues in unified format.
    • See https://aka.ms/opiweb for all issues index.
  • The issue registries are versioned, so that you always know the set of issues by the specific version.
    • See this json file for the latest version of all the issues.
    • For the same file, see version 1.0.0-alpha1.
      • So that you could code against a given version, they are immutable.

• Shared help links to the tech documentations

  • Along with the issue, there's a doc link to the post addressing the issue.
  • When new post are written, you get it for free.

• Tool sets for querying/maintaining the issues.

• SDK support in the future that you will be able to access issues by code.

• Semantics that will be handled by the SDK

• Semantics that you will need to provide

• Generate localization resources for known issues.
  • The issue registry will be published at https://aka.ms/opi-registry. It will be in form perf-issue.version.json.
    • For example: perf-issue.20230201.json.