Giter VIP home page Giter VIP logo

sap / alm-plug-in-for-grafana Goto Github PK

View Code? Open in Web Editor NEW
11.0 10.0 5.0 2.05 MB

Extend your analytics for application life-cycle management with the datasource plugins for SAP Cloud ALM and SAP Focused Run. With the SAP Cloud ALM Plugin for Rest interface, you are able to connect your SAP Cloud ALM tenants and get data in Table format or Time-series format to get new insights on your different ALM processes.

License: Apache License 2.0

JavaScript 3.65% TypeScript 94.64% Dockerfile 1.37% Shell 0.33%
frun grafana-plugin calm

alm-plug-in-for-grafana's Introduction

CI REUSE status

ALM Plug-In for Grafana

Latest release Latest release

The ALM plug-in for Grafana (alm-plug-in-for-grafana) lets you extend your analytics solutions for application life-cycle management.

This plugin is based on the SAP Cloud ALM analytics API, which is documented here. This API enables you to build dashboards and reports aggregating all types of data managed by SAP Cloud ALM. It comes with OData and REST endpoints exposing analytics data.

With the SAP ALM plug-in for REST interface you are able to connect your SAP Cloud ALM tenants and get data in table format or time-series format to get new insights into your various ALM processes.

The goals of the SAP Cloud ALM analytics API are:

  • Access SAP Cloud ALM analytics through a generic single-entry point.
  • Mix analytics data from all SAP Cloud ALM components (use-cases) by means of a standard API.
  • Access time series as well as table data on the same interface.
  • Consume SAP Cloud ALM analytics from SAP Analytics Cloud or from an OData consumer without coding.
  • Consume SAP Cloud ALM analytics from third-party frontend applications

Content

The ALM plug-in for Grafana provides the following components:

Want to learn more

If you want to learn more about SAP Cloud ALM:

If you want to learn more about SAP Cloud ALM API, see the following:

How to obtain support

Create an issue in this repository if you find a bug or have questions about the content.

For additional support, ask a question in SAP Community.

Contributing

Check out CONTRIBUTING.md

License

Copyright (c) 2022 SAP SE or an SAP affiliate company. All rights reserved. This project is licensed under the Apache Software License, version 2.0 except as noted otherwise in the LICENSE file.

alm-plug-in-for-grafana's People

Contributors

andreacampo avatar sawbou avatar vienlam avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

alm-plug-in-for-grafana's Issues

Enhance Filters Selection Organization

The scenario is when we have lots of filter, some will not be displayed as they are outside the width of element. One have to scroll to see them.
Improve it so that we can still see them without scrolling.

Authentication to data source failed

I have just installed grafana plugin, but when I press save and test after I have given the Token URL, Clisnt ID, and Client Secret. Then it says Authentication to data source failed.

I am sure the client ID and client secret are correct and working, so I am thinking, if it is becuase I dont use SSL on my grafana server? Cloud it be some security there, that is rejecting me ?

Or do someone have a good idea, where I can look, for finding the error ?

Support new resolution

We need to add the support of the following resolutions in the Grafana plugin:

  • 5mi
  • 15mi
  • 30mi

Period issue with Raw Table format

When using Raw Table format, even if current 6 months/days/hour period is selected, the backend processes the request with the period current 1 month/days/hour.
This is the expected behaviour for the Table format, not for the Raw Table one, where the selected time period should always be taken in consideration without modifications.

Dynamic query filters

The visibility of some filters in the query configuration depends on the value of other related filters.
E.g. The two filters below, Product and bigIntNbDigits are visible only when the value of showAdditionalMeta is set to "Enabled"

image

But when setting the value of showAdditionalMeta to "Disabled", the two filters are still visible:

image

Solution: when doing a refresh in the query configuration all the filters should be set to the initial Data Provider status. The provider would be in charge to send everytime the complete list of filter values.

SAP ALM plugin is not detected in Grafana

Hello

I tried installing the ALM plugin using the instructions provided in Github but I couldn't find the plugin in Grafana user interface.

We have Grafana v10.0.3 installed in 2 instances(HA) which are in active-active mode.
Its an Enterprise version and its installed in RHEL 9.

We installed the plugin in both the instances but we couldn't find the ALM plugin under New Data source.

Thanks
Suren

Add packaged plugin to release

Greetings,

Would it be possible to package and attach the plugin to the release?
Or even push it to the grafana marketplace?

kind regards

Add an option to set the timestamp of the most recent datapoint to "now"

When using hourly granularity, the last data point in a time series with a time period like "now-3h" has a timestamp aligned to the hour.
For example, at 9:40, the last data point is set 9:00.

image

The last data point is calculated considering the period 9:00 - 9:40 and is recalculated at each refresh. As a consequence, the value of the last data point can be different depending on the time of the refresh.

When using the TimeSeries visualization in Grafana, the time axis always includes the most recent timestamp (in this example 9:40). This behaviour leads to an increasing "gap" between the last visible data point and the end of the graph.

image

An option should be added in the query configuration to set timestamp of the last data point to the most recent one.

image

install issue

Hi,

we have an issue installing the plugin after compiling it with yarn:

bash-5.1$ cd /var/lib/grafana/plugins
bash-5.1$ ls
sap-alm-dp-api-datasource
bash-5.1$ grafana-cli plugins install sap-alm-dp-api-datasource
Error: โœ— Plugin not found (Grafana v8.4.7 linux-amd64)

It noted in the documentation that we should raise an issue to receive an official plugin version.

Also: will this plugin be available for Azure Managed Grafana in the future?

Issue when trying to use the ALM plugin : Fetch error: 404 Not Found Instantiating module.js

Hello,

I encounter this error message when trying to create a new datasource based on sap-alm-dp-api-datasource :

Fetch error: 404 Not Found Instantiating http://localhost:3000/public/plugins/sap-alm-dp-api-datasource/module.js Loading plugins/sap-alm-dp-api-datasource/module

I'm running grafana 9.4.7.

I've built the software using :
Yarn 1.22.19
Node js 18.17.1
Using "yarn build" / "yarn install". Got a couple of warnings but no errors.

Any idea of what could be wrong and how to solve it ?

Thanks & Best regards !

alm-plug-in-for-grafana --> An unexpected error happened during exploring Data Providers

Hello everyone,
we are using the Grafana plugin for SAP Cloud ALM and always get the error message "An unexpected error happened" when using the data provider (ALM Business Process Monitoring - KPI_HISTORY_TOTALS). In the Dev Tools under Network I see the following error regarding "PRECONDITION_REQUIRED : Missing filter for dimension 'kpiId'", but I cannot define the filter because the unexpected error appears first.
{
"error": {
"code": "PRECONDITION_REQUIRED",
"message": "PRECONDITION_REQUIRED : Missing filter for dimension 'kpiId'",
"target": "",
"details": [
{
"code": "x-correlationid",
"message": "d0b2e6fe-bc37-4a4c-6ee6-bb0e9917ab8e"
}
]
}
}
With (ALM Real User Monitoring - DP_RUM_REQUEST_TYPES) the unexpected error also appears, with the info "PRECONDITION_REQUIRED : At most 5 services or systems allowed in scope. Add filters to restrict number of services or systems.", but again the unexpected error occurs before I can define a filter.
{
"error": {
"code": "PRECONDITION_REQUIRED",
"message": "PRECONDITION_REQUIRED : At most 5 services or systems allowed in scope. Add filters to restrict number of services or systems.",
"target": "",
"details": [
{
"code": "x-correlationid",
"message": "f906cc9a-2e9f-4b14-7c16-045ca9dce2ef"
}
]
}
}
The service instance has the required scope calm-api.bm.read and calm-api.rum.read

Thanks & best regards,
Sascha

Option for first day of week

We need option for first day of week. In some use cases, the first day of the week is different between Saturday, Sunday, and Monday.
Need to check Grafana settings for first day of week is usable in Data Source plugin.

install

Hi, please share signed copy of the plugin with us. Thanks

Unable to use mixed data sources

We would like to consolidate key data from multiple sources onto a single dashboard. For that, Grafana enables to use multiple data sources. Attempting to use those, only the last query works and first data source(s) return an error.

Plugin commit: bc0ddfb
Grafana version: 10.1.2

Screenshot from 2023-11-02 14-16-57

SAP ALM and Grafana Cloud

Hi there!

Was curious about the appetite for getting this ALM integration for SAP signed and into grafana cloud?

Cloud ALM API not found

This API is the only API I can get to work
https://mycloudalm.eu10.alm.cloud.sap/api/calm-analytics/v1

If I try any of these of these API's, then it says not found, when I create a new datasource in grafana
https://mycloudalm.eu10.alm.cloud.sap/api/calm-landscape/v1
https://mycloudalm.eu10.alm.cloud.sap/api/calm-logs/v1
https://mycloudalm.eu10.alm.cloud.sap/api/calm-traces/v1
https://mycloudalm.eu10.alm.cloud.sap/api/calm-event-situations/v1

I am sure, the connection details is correct, since I can make analytics work, but why all others says not found? Any ideas ?

Cannot read properties of undefined (reading 'meta')

Hello

I have an error after plugin configuration. During the configuration everything looks fine. "Data Providers Settings" are visible and I have green box "Data source is working". Then when I try to open Explorer I have below error message:.
Can you please advise?

An unexpected error happened
Details
TypeError: Cannot read properties of undefined (reading 'meta')

    at t (https://MY_GRAFANA_URL/public/build/4743.fc5befcd39e4d04d2f72.js:2:568276)
    at Ur (https://MY_GRAFANA_URL/public/build/4743.fc5befcd39e4d04d2f72.js:2:638387)
    at c (https://MY_GRAFANA_URL/public/build/8339.15467d3678c125574e97.js:71:1128)
    at ei (https://MY_GRAFANA_URL/public/build/explore.cd9df6b98b317bc08878.js:307:1252)
    at div
    at o (https://MY_GRAFANA_URL/public/build/7180.b4c11f4be0293b7712ff.js:2181:861)
    at div
    at div
    at div
    at t (https://MY_GRAFANA_URL/public/build/4743.fc5befcd39e4d04d2f72.js:2:711588)
    at p (https://MY_GRAFANA_URL/public/build/7180.b4c11f4be0293b7712ff.js:424:3279)
    at io (https://MY_GRAFANA_URL/public/build/explore.cd9df6b98b317bc08878.js:491:3571)
    at g (https://MY_GRAFANA_URL/public/build/4743.fc5befcd39e4d04d2f72.js:2:1042468)
    at WithTheme(Connect(io))
    at div
    at co (https://MY_GRAFANA_URL/public/build/explore.cd9df6b98b317bc08878.js:514:3053)
    at g (https://MY_GRAFANA_URL/public/build/4743.fc5befcd39e4d04d2f72.js:2:1042468)
    at WithTheme(Connect(co))
    at c (https://MY_GRAFANA_URL/public/build/7180.b4c11f4be0293b7712ff.js:1207:301)
    at u (https://MY_GRAFANA_URL/public/build/7180.b4c11f4be0293b7712ff.js:1207:855)
    at div
    at div
    at yo (https://MY_GRAFANA_URL/public/build/explore.cd9df6b98b317bc08878.js:530:350)
    at Suspense
    at c (https://MY_GRAFANA_URL/public/build/7180.b4c11f4be0293b7712ff.js:1207:301)
    at ts (https://MY_GRAFANA_URL/public/build/7180.b4c11f4be0293b7712ff.js:5576:348)
    at t (https://MY_GRAFANA_URL/public/build/4743.fc5befcd39e4d04d2f72.js:2:1060861)
    at t (https://MY_GRAFANA_URL/public/build/4743.fc5befcd39e4d04d2f72.js:2:1062882)
    at main
    at Rt (https://MY_GRAFANA_URL/public/build/7180.b4c11f4be0293b7712ff.js:5537:6824)
    at t (https://MY_GRAFANA_URL/public/build/4743.fc5befcd39e4d04d2f72.js:2:1057479)
    at div
    at o (https://MY_GRAFANA_URL/public/build/7180.b4c11f4be0293b7712ff.js:2005:4594)
    at t.KBarProvider (https://MY_GRAFANA_URL/public/build/4743.fc5befcd39e4d04d2f72.js:2:271053)
    at l (https://MY_GRAFANA_URL/public/build/7180.b4c11f4be0293b7712ff.js:6297:20329)
    at c (https://MY_GRAFANA_URL/public/build/7180.b4c11f4be0293b7712ff.js:1207:301)
    at u (https://MY_GRAFANA_URL/public/build/7180.b4c11f4be0293b7712ff.js:1207:855)
    at l (https://MY_GRAFANA_URL/public/build/4743.fc5befcd39e4d04d2f72.js:2:1040513)
    at As (https://MY_GRAFANA_URL/public/build/7180.b4c11f4be0293b7712ff.js:5589:167)

PS. I replaced real URL with MY_GRAFANA_URL

Grafana install on windows

I have installed the data source sap-alm.dp-api-datasource plud in on grafana.

I do also see the plud in, but when I press blue button add new data source, and it add's it. There is no input fields. Only there is button delete and back, which should be in the button of the screen, after all the input fields.

I have added parameter allow_loading_unsigned_plugins=sap-alm-dp-api-datasource both in file defaults.ini and custom.ini (which is a copy of defaults.ini. I do also see the parameter in settings in grafana under pludins. So I think that is ok.

I have changed app_mode to development, instead of production. I read somewhere that was needed, to run unsigned plugins. That is not helping much.

I ran yarn install and yarn build, and that seems to work okay. Some warnings, but no errors. But when building with yarn build it says enviroment production. So I have tried yarn dev, but then it does not finish compiling. So not sure, what is right.

If i press F12 in browser, when I try to add the datasource, I see under console it says.

Failed to load resource: the server responded with a status of 404 (Not Found)
:3000/api/gnet/plugins/sap-alm-dp-api-datasource:1

{
"code": "NotFound",
"message": "plugin not found",
"requestId": "0c934ea3-03f0-4409-ba59-272b10be38d0"
}

So something is wrong, but is it parameter, which I beleave is ok, since it can not find it?
Is it yarn build, or yarn dev, which is needed?
So app_mode be developemnt or production ?

Dist files, are not modified yet. I would go with option, that I keep "zudr", and give information in the plug in.

Any ideas, what it could be?

Not building in Grafana 9.4.7 Docker image

Hello

I'm building extension inside Grafana Docker image. Unfortunately it stopped working in image version 9.4.7. It looks like dependencies issue during the "yarn install". Build was working fine in previous version 9.4.3.

Can you please help?

image: docker.io/grafana/grafana-enterprise:9.4.7
plugin version: 1.1.2

 => ERROR [build 7/7] RUN yarn install && yarn build                                                                                                                                                        78.0s
------
 > [build 7/7] RUN yarn install && yarn build:
#0 1.057 yarn install v1.22.19
#0 1.097 info No lockfile found.
#0 1.112 [1/5] Validating package.json...
#0 1.118 [2/5] Resolving packages...
#0 3.886 warning Resolution field "[email protected]" is incompatible with requested version "[email protected]"
#0 5.017 warning @grafana/data > react-use > nano-css > [email protected]: Please use @jridgewell/sourcemap-codec instead
#0 6.542 warning Resolution field "[email protected]" is incompatible with requested version "[email protected]"
#0 7.427 warning Resolution field "[email protected]" is incompatible with requested version "[email protected]"
#0 8.337 warning @grafana/runtime > @grafana/ui > react-highlight-words > [email protected]: New custom equality api does not play well with all equality helpers. Please use v5.x
#0 8.753 warning @grafana/runtime > @grafana/ui > slate-react > [email protected]: New custom equality api does not play well with all equality helpers. Please use v5.x
#0 9.580 warning @grafana/runtime > @grafana/faro-web-sdk > @grafana/faro-core > @opentelemetry/[email protected]: Please use @opentelemetry/api >= 1.3.0
#0 11.25 warning @grafana/runtime > @grafana/ui > rc-time-picker > rc-trigger > babel-runtime > [email protected]: core-js@<3.23.3 is no longer maintained and not recommended for usage due to the number of issues. Because of the V8 engine whims, feature detection in old core-js versions could cause a slowdown up to 100x even if nothing is polyfilled. Some versions have web compatibility issues. Please, upgrade your dependencies to the actual version of core-js.
#0 23.53 warning @grafana/toolkit > @jest/core > jest-config > jest-environment-jsdom > jsdom > [email protected]: Use your platform's native performance.now() and performance.timeOrigin.
#0 24.05 warning @grafana/toolkit > css-minimizer-webpack-plugin > cssnano > cssnano-preset-default > postcss-svgo > svgo > [email protected]: Modern JS already guarantees Array#sort() is a stable sort, so this library is deprecated. See the compatibility table on MDN: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#browser_compatibility
#0 24.14 warning Resolution field "[email protected]" is incompatible with requested version "[email protected]"
#0 25.14 warning @testing-library/jest-dom > css > [email protected]: Please see https://github.com/lydell/urix#deprecated
#0 25.15 warning @testing-library/jest-dom > css > [email protected]: See https://github.com/lydell/source-map-resolve#deprecated
#0 25.15 warning @testing-library/jest-dom > css > source-map-resolve > [email protected]: Please see https://github.com/lydell/urix#deprecated
#0 25.23 warning @testing-library/jest-dom > css > source-map-resolve > [email protected]: See https://github.com/lydell/source-map-url#deprecated
#0 25.23 warning @testing-library/jest-dom > css > source-map-resolve > [email protected]: https://github.com/lydell/resolve-url#deprecated
#0 25.75 [3/5] Fetching packages...
#0 71.63 warning [email protected]: The engine "browsers" appears to be invalid.
#0 71.64 error [email protected]: The engine "node" is incompatible with this module. Expected version "^12 || ^14 || ^16 || ^17". Got "18.14.2"
#0 71.65 error Found incompatible module.
#0 71.65 info Visit https://yarnpkg.com/en/docs/cli/install for documentation about this command.
------

Update Documentation with plugin.json backup

In the assembly section of the README file it is recommended to replace the entire dist folder. In case of upgrades we should recommend the backup of the plugin.json file because it could contain some endpoints/security tokens previously configured for Cloud ALM.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.