layer5io / meshery-smp-action

GitHub Action for pipelining microservices and Kubernetes performance testing with Meshery
https://layer5.io/projects/nighthawk
Apache License 2.0
27 stars 21 forks source link

Rename the profiles of performance tests #59

Closed gyohuangxin closed 1 year ago

gyohuangxin commented 1 year ago

Current Behavior

Performance test profiles are named as {service-mesh}-{load-generator}-{test-configuration}.yaml currently, it‘s ugly and hard to understand. image

The goal of this issue is to discuss and find out the how to make the profile names be in order for people to understand what is being tested.

gyohuangxin commented 1 year ago

@leecalcote @hershd23

leecalcote commented 1 year ago

Perfect. @asubedy is here to assist.

hershd23 commented 1 year ago

It is ugly, but it has complete information about the test as it just - separates all the parameters.

In the new naming construct, do we want this information in the title or some kind of metadata? Maybe we can also add whether the test was run on the GitHub runner or personal hardware

gyohuangxin commented 1 year ago

@hershd23 Yes, it's just ugly but its information is enough. We can rename this profile name with human readable text, like Istio Soak Test with Fortio, but it‘s also fine if still using -. @leecalcote What do you think?

asubedy commented 1 year ago

Maybe we can also add whether the test was run on the GitHub runner or personal hardware

I guess this would be good to add as a subtext on the card. The performance profile 1,2,3 doesn't look good.

gyohuangxin commented 1 year ago

@asubedy Yes, it's a good idea. Where does the subtext come from? How can we put information here?

asubedy commented 1 year ago

@gyohuangxin Right now the subtext is hardcoded.

hershd23 commented 1 year ago

Sure @asubedy @gyohuangxin let's go with the runner type in the subtext. As far as the main performance test goes, trying to make it a coherent English sentence and - separating stuff doesn't seem different at all to me.

Are we fixated on the Title-Subtitle format @asubedy or can we just specify a UUID type identifier for the test and list the configurations on the card, like service mesh - istio. Test - load test and so on with the datetime of test completion?

asubedy commented 1 year ago

@hershd23 I think having a title on the card is necessary. Other details can be listed as you said.

hershd23 commented 1 year ago

Hi did we come to any conclusions here?

gyohuangxin commented 1 year ago

Great! As details can be listed in the subcontext, we can list current informations as below:

Istio Load Test with Forito

Service mesh: Istio Load generator: Fortio Test configuration: Load test Date: Aug 10 21:39:33 CST 2022

gyohuangxin commented 1 year ago

@hershd23 @asubedy What do you think?

asubedy commented 1 year ago

@gyohuangxin yes this looks good. Just one change, simply date does not explain lots of things, maybe Date updated or date created something that is relevant

gyohuangxin commented 1 year ago

@asubedy Great, thanks for your suggestion. It looks good.

Istio Load Test with Forito

Service mesh: Istio Load generator: Fortio Test configuration: Load test Date Created: Aug 10 21:39:33 CST 2022 Date Updated: Aug 11 11:29:42 CST 2022

gyohuangxin commented 1 year ago

@hershd23 Can you raise a PR to change the profiles' names?