Skip to content
This repository has been archived by the owner on Dec 8, 2021. It is now read-only.

add auxmoney-waterfall-panel 1.0.3 #863

Merged
merged 4 commits into from
Apr 26, 2021

Conversation

cawolf
Copy link
Contributor

@cawolf cawolf commented Feb 9, 2021

No description provided.

@marcusolsson marcusolsson added submission/new Submission is a new plugin type/panel Categorizes the submission as a panel labels Feb 10, 2021
@marcusolsson
Copy link
Contributor

Hi @cawolf,

This plugin has a private signature. To publish on grafana.com, it needs to be signed as Community or Commercial. Would you like me to configure a Community signature for this plugin? You will have to sign the plugin again and update your PR with the new signature.

@marcusolsson marcusolsson added the milestone/needs-changes Submission needs changes before it can be approved label Mar 3, 2021
@cawolf
Copy link
Contributor Author

cawolf commented Mar 4, 2021

Hi @marcusolsson ,
yes, we would like to use a community signature. The corresponding ticket was declined from your support, and instead a direct PR to this repository was proposed.
We will sign the plugin again as soon as we get the new signature from you (you can use our plugin contact email address opensource@auxmoney.com).

@cawolf
Copy link
Contributor Author

cawolf commented Mar 18, 2021

Hi @marcusolsson ,
did you provide the community signature to us already? If so, how can we retrieve it?

@marcusolsson
Copy link
Contributor

I've configured auxmoney-waterfall-panel to be signed as a Community plugin. Please make sure that you use a API key that was created using the auxmoney org account when you sign it.

@marcusolsson
Copy link
Contributor

I've had the chance to review the plugin:

  • The plugin selects the field to use based on the field name. Since the plugin requires three separate types of fields, I recommend that you instead look for fields of a specific type. For example, instead of

    series.fields.filter(field => field.name === 'Time')[0];
    series.fields.filter(field => field.name === 'value')[0];
    series.fields.filter(field => field.name === 'name')[0];
    
    series.fields.find(field => field.type === FieldType.time);
    series.fields.find(field => field.type === FieldType.number);
    series.fields.find(field => field.type === FieldType.string);
    

    I find that it makes it easier to get started. Alternatively, let the users select the name of the field to use.

  • I'd recommend that you add some docs in the README on how to configure the panel. Such as what fields does the panel expect (name/type), which ones are required/optional, and what are they used for. I had to look at the source code to figure out what it expected.

  • The label is currently drawn outside of the bar. Maybe add some sensible padding?

    Screenshot 2021-03-22 at 15 25 42@2x
  • Finally—and considered this more of a feature request—I think it would've been helpful to have some form of relative/absolute time on the x-axis to help me see where when the events happened, rather than just their duration.

I don't think any of these points are blockers, but I'd recommend making it a little easier to get started by addressing my first two points. Let me know if you'd like to address any of the feedback 👍

cawolf added a commit to auxmoney/grafana-waterfall-panel that referenced this pull request Apr 1, 2021
cawolf added a commit to auxmoney/grafana-waterfall-panel that referenced this pull request Apr 1, 2021
@cawolf
Copy link
Contributor Author

cawolf commented Apr 1, 2021

I built a new version and implemented the 2 main changes you proposed. I will create separate issues for your feature request and the padding / UI issues soon.

@marcusolsson
Copy link
Contributor

v1.0.4 looks ready to publish, but v1.0.3 doesn't have a valid signature. Could you remove 1.0.3 from the PR and I'll publish this?

@cawolf
Copy link
Contributor Author

cawolf commented Apr 26, 2021

Hey @marcusolsson , I removed the invalid signed version as you requested.

@marcusolsson
Copy link
Contributor

I've published the plugin to the marketplace 🎉 , but please allow for a few minutes before it's available.

@marcusolsson marcusolsson merged commit 65af0b7 into grafana:master Apr 26, 2021
@marcusolsson
Copy link
Contributor

Looks like you may have forgotten to update the package.json version. I published 1.0.4, but it's listed as 1.0.3 on the website. It doesn't matter so much to us, but we should probably update repo.json to reflect this.

@cawolf
Copy link
Contributor Author

cawolf commented Apr 27, 2021

You are right, there is a release script misconfiguration. I will sort this out and create a new PR for this.

Thanks for taking your time and publishing our pluging! 👍

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
milestone/needs-changes Submission needs changes before it can be approved submission/new Submission is a new plugin type/panel Categorizes the submission as a panel
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants