gobench-io / gobench Goto Github PK

I want to enhance Gobench with support for multiple deployment options to make it more accessible and convenient for users. The following deployment options should be considered:

• Manual install
• Docker Container
• Kubernetes (K8s) Helm chart
• Terraform

By supporting these deployment options, we aim to make Gobench more accessible and adaptable to various deployment scenarios. I welcome input, contributions, and suggestions from the community to help implement and improve these deployment options.

Please share your thoughts, ideas, or any additional deployment options that you think would be valuable for Gobench.

Thank you for your support and collaboration!

Here are a few suggestions to consider when adding support for deployment options in Gobench

Documentation: Create clear and detailed documentation for each deployment option, including step-by-step instructions, configuration parameters, and any prerequisites or dependencies. This will help users understand how to deploy Gobench using different methods.

Examples and Templates: Provide sample configurations, Dockerfiles, Kubernetes manifests, Helm charts, and Terraform scripts as examples. These examples will serve as starting points for users to customize and adapt Gobench deployment to their specific needs.

Integration Testing: Set up automated integration tests that validate the deployment options. This will help ensure that Gobench can be successfully deployed and run using different methods, providing confidence to users.

Version Compatibility: Specify the compatibility of Gobench with different deployment options, including the minimum required versions of Docker, Kubernetes, Helm, and Terraform. Regularly update and test Gobench against new versions to ensure ongoing compatibility.

Continuous Integration/Deployment (CI/CD): Integrate Gobench's deployment options into Github Action to automate the building and testing of Docker images, Helm charts, and Terraform scripts. This ensures that changes and updates to the deployment options are thoroughly tested.

Create a video for Gobench's quick start. This's very helpful for people to quickly understand how to use Gobench.

I think we should not use caret when setting up the environment in CI to avoid compatible issues between deps.

Currently:

- name: Set up Go 1.16
  uses: actions/setup-go@v2
  with:
    go-version: ^1.16
  id: go

- name: Set up Nodejs 14
  uses: actions/setup-node@v2
  with:
    node-version: ^14.15
  id: node

CI will use Go 1.20.5 and Node 14.21.3

Why do we need to upgrade the UI to version 2?

The current Gobench UI requires a license. Therefore, we change to another template.

What's new

1. Modern template & font
2. Optimize real-time charts performance
3. Summarize metrics for a period
4. Responsive
5. Remember logged in session

Reference

1. Theme - https://github.com/primefaces/sakai-react
2. Charts - https://echarts.apache.org/examples/en/index.html#chart-type-bar
3. Repository - https://github.com/gobench-io/gobench-ui

Description:

🚀 We are seeking contributions to enhance the UI functionality of Gobench v2! We aim to implement a new feature that allows users to easily GET/SET target server resource information within the Gobench application. This feature might link to Grafana or get metrics from other metric servers like Prometheus.

🔍 Task:
Create an intuitive user interface that enables users to input and modify target server resource information, such as CPU, Memory, Network In/Out, and other relevant metrics. Additionally, implement a feature to fetch and display the existing server resource information for reference.

💡 Possible Integrations:
Explore the possibility of integrating Gobench with Grafana or other metric servers like Prometheus. Users should be able to seamlessly import resource metrics from these external sources and utilize them for more comprehensive benchmarking analysis.

💻 Skills Needed:

• Proficiency in UI/UX design and development
• Experience with frontend technologies (HTML, CSS, JavaScript, etc.)
• Familiarity with RESTful APIs or backend integration is advantageous but not required

🙌 Join our open-source community and contribute to the success of Gobench v2. Your contributions will empower users to seamlessly configure their target server resource information, link to external metrics sources, and streamline the benchmarking process with valuable insights.

📌 If you're interested in collaborating with us on this UI enhancement, leave a comment on this issue to express your interest. Let's work together to make target server resource management and metric integration a breeze for our users!

Tech task:

1. define cli for master and agent
2. implement option parser for master and agent

Consider using this pkg https://github.com/peterbourgon/ff

From HuyHa: Suggestion use library cli https://github.com/spf13/cobra

I had a prototype here https://github.com/nqd/gobench/blob/topology/main.go#L22 but used as ref

When running in distributed mode, the master needs to know the working agents.

We will implement a simple heartbeat via gRPC to check for liveness of master and agent.

Tech tasks:

• define gRPC schema
• implement the heartbeat

Replace the current chart (Apexcharts) with a better chart (Victory is recommended, it’s supports zoom for large data: https://formidable.com/open-source/victory/guides/zoom-on-large-datasets).

Demo play around with Victory chart: https://react-49ulrq.stackblitz.io/
Code: https://stackblitz.com/edit/react-49ulrq?file=src%2FApp.js

Using a new UI template (Prime react is recommended) or keep current (antd) and upgrade to latest version.

• Option 1: Try to upgrade antd to latest version
• Option 2: Change to new UI - Prime react

Able to group applications by tags.

Description:

🚀 We need your help to enhance the UI functionality of Gobench v2! We are looking to add a new feature that allows users to compare benchmark results of two Gobench applications effortlessly.
The UI feature enables users to select and view benchmark results from two different Gobench applications side by side, facilitating comparison between the two sets of data. This can be valuable for users who want to analyze and contrast the performance or metrics of their applications under different conditions or configurations.
By offering the ability to compare benchmark results, users can gain deeper insights into their application's performance and identify any variations or improvements between the two test runs.

🔍 Task:
Implement a side-by-side comparison view where users can select and visualize the benchmark results from two different Gobench applications. This feature will empower users to analyze performance variations, identify trends, and make data-driven decisions for their applications.

💻 Skills Needed:

• Proficiency in UI/UX design and development
• Experience with frontend technologies (HTML, CSS, JavaScript, etc.)
• Familiarity with Gobench or benchmarking tools is a plus, but not required

🙌 Join our open-source community and make a significant impact on the Gobench project. Your contributions will help users gain deeper insights into their applications' performance and foster better decision-making.

📌 If you're excited to collaborate with our team and tackle this UI challenge, leave a comment on this issue to express your interest and get started!

Objective: Create wireframes for Gobench v2 web app UI to visualize layout and interactions.

Requirements:

Homepage Wireframe: Create a wireframe for the homepage that showcases key features, project statistics, and navigation elements. Consider the layout, call-to-action buttons, and any important information that should be displayed on the homepage.

Benchmarking Scenario Creation: Design wireframes for the benchmarking scenario creation process. This includes defining the inputs, parameters, and options for setting up different benchmark scenarios. Consider providing clear guidance and validation messages to assist users in creating scenarios correctly.

Scenario Dashboard: Create wireframes for the scenario dashboard, where users can view and manage their created benchmark scenarios. Include options for editing, duplicating, and deleting scenarios, as well as relevant statistics and status indicators.

Result Visualization: Design wireframes for visualizing benchmarking results. Include graphs, charts, and other visual elements to represent data in an informative and easy-to-understand manner.

User Settings and Authentication: Create wireframes for user settings and authentication pages, allowing users to manage their accounts, update preferences, and securely log in/out of the application.

Responsive Design: Ensure that the wireframes consider responsive design principles, providing a consistent and user-friendly experience across different devices and screen sizes.

Provide an API for Frontend to get some statistic counters like total Gobench applications, total healthy agents, total scenarios, etc.

Sometimes, the Gobench UI show popup request failed or request data not found or request data does not exist. It's might be a problem when we deploy Gobench on a cross-region. For example, I deployed Gobench in the US but I access the Gobench UI from Vietnam. So, the response time for each request is high and the request was time out.

Screen shoots

Solution

I increase the request timeout for Axios (an HTTP client library).

Description:

🚀 We are looking for contributors to enhance the UI functionality of Gobench v2! Our goal is to introduce a new feature that enables users to export benchmark results for easy reporting and analysis.

🔍 Task:
Implement a user-friendly export feature that allows users to download benchmark results in various formats, such as CSV, JSON, or PDF. This functionality will empower users to generate reports, share data with stakeholders, and perform further analysis.

💻 Skills Needed:

• Proficiency in UI/UX design and development
• Experience with frontend technologies (HTML, CSS, JavaScript, etc.)
• Familiarity with data export libraries or APIs is advantageous but not required

🙌 Join our open-source community and contribute to the success of Gobench v2. Your efforts will facilitate seamless data reporting and add value to users' benchmarking experience.

📌 If you're interested in collaborating with us on this UI enhancement, leave a comment on this issue to express your interest. Let's work together to make data export a breeze for our users!

At the moment, we are creating an application as a form in the Application list.
Should we split them into 2 pages?

The installation document is out of date because of the deprecation of 'go get' for installing executables.
We will use go install instead go get.

Example to install the latest binary from the master branch

go install github.com/gobench-io/gobench@master

https://go.dev/doc/go-get-install-deprecation

Replace redux-saga with redux-toolkit, which is popular used with React to handle fetching API data and state management. The Redux toolkit will also support interval polling, and caching data and will improve application performance.

One linter for this project

https://golangci-lint.run/

Update Application list API to support more information

A summary results for each scenario can help us save more time to check the error of a scenario.