From d1ac9b466926e3a19ce79cbd90fa4ed62c097c00 Mon Sep 17 00:00:00 2001 From: Ramanath Shanbhag Date: Fri, 17 Jul 2026 16:48:14 +0530 Subject: [PATCH] v201 doc updates and output generation Signed-off-by: Ramanath Shanbhag --- .../grafana/rmf-app/access_grafana_zosmf.html | 24 +- docs/grafana/rmf-app/alerts.html | 12 +- docs/grafana/rmf-app/apply_visualize.html | 30 +- docs/grafana/rmf-app/context-help-map.xml | 16 +- docs/grafana/rmf-app/create_datasources.html | 20 +- docs/grafana/rmf-app/dashboards_overview.html | 185 +++++++++++ .../grafana/rmf-app/define_grafana_zosmf.html | 40 ++- docs/grafana/rmf-app/error_reports.html | 8 +- .../grafana/rmf-app/grafana_config_parms.html | 130 ++++---- docs/grafana/rmf-app/grafana_via_zosmf.html | 10 +- docs/grafana/rmf-app/historical_data.html | 8 +- docs/grafana/rmf-app/images/app_section.png | Bin 8429 -> 0 bytes .../grafana/rmf-app/importing_dashboards.html | 93 ++++-- docs/grafana/rmf-app/index.html | 6 +- docs/grafana/rmf-app/indexTerms.html | 4 +- .../rmf-app/install_grafana_plugin.html | 201 ++--------- .../install_grafana_plugin_legacy.html | 311 ++++++++++++++++++ docs/grafana/rmf-app/install_plugin_cli.html | 201 +++++++++++ .../rmf-app/install_plugin_docker.html | 271 +++++++++++++++ docs/grafana/rmf-app/install_plugin_ui.html | 209 ++++++++++++ .../rmf-app/install_sample_dashboards.html | 236 +++++++++++++ .../rmf-app/integrating_dds_omegamon.html | 19 +- .../app/context-help/context-help-map.js | 2 +- .../json/dashboards_overview-d526e164.js | 1 + ...3e208.js => grafana_via_zosmf-d526e318.js} | 2 +- .../json/install_grafana_plugin-d526e60.js | 1 + .../app/nav-links/json/nav-links.js | 2 +- ...f-d423e227.js => prereq_zosmf-d526e337.js} | 2 +- .../app/search/index/htmlFileInfoList.js | 2 +- .../app/search/index/index-1.js | 2 +- .../app/search/index/index-2.js | 2 +- .../app/search/index/index-3.js | 2 +- .../app/search/index/keywords.js | 43 ++- .../app/search/index/link-to-parent.js | 2 +- docs/grafana/rmf-app/pdf/rmf_grafana.pdf | Bin 1157099 -> 1235832 bytes docs/grafana/rmf-app/pdf_guide.html | 8 +- docs/grafana/rmf-app/prereq_plugin.html | 180 ++++++++++ docs/grafana/rmf-app/prereq_zosmf.html | 8 +- .../rmf-app/prometheus_sample_dashboards.html | 213 ------------ .../grafana/rmf-app/prometheus_sample_db.html | 211 ++++++++++++ docs/grafana/rmf-app/query_lang.html | 23 +- docs/grafana/rmf-app/rn.html | 63 ++-- docs/grafana/rmf-app/search.html | 18 +- docs/grafana/rmf-app/sitemap.xml | 80 +++-- docs/grafana/rmf-app/ts_issues.html | 8 +- docs/grafana/rmf-app/update_plugin.html | 144 ++++---- docs/grafana/rmf-app/variables.html | 12 +- docs/grafana/rmf-app/visual_grafana.html | 12 +- grafana/rmf-app/CHANGELOG.md | 6 +- .../rmf-app/doc/src/access_grafana_zosmf.dita | 31 +- grafana/rmf-app/doc/src/apply_visualize.dita | 7 +- grafana/rmf-app/doc/src/conref.dita | 68 +++- .../rmf-app/doc/src/create_datasources.dita | 4 +- .../rmf-app/doc/src/dashboards_overview.dita | 34 ++ .../rmf-app/doc/src/define_grafana_zosmf.dita | 32 +- .../rmf-app/doc/src/grafana_config_parms.dita | 50 ++- .../rmf-app/doc/src/importing_dashboards.dita | 79 +++-- .../doc/src/install_grafana_plugin.dita | 251 +++----------- .../src/install_grafana_plugin_legacy.dita | 186 +++++++++++ .../rmf-app/doc/src/install_plugin_cli.dita | 52 +++ .../doc/src/install_plugin_docker.dita | 139 ++++++++ .../rmf-app/doc/src/install_plugin_ui.dita | 62 ++++ .../doc/src/install_sample_dashboards.dita | 87 +++++ .../doc/src/integrating_dds_omegamon.dita | 4 +- grafana/rmf-app/doc/src/pdf/rmf_grafana.pdf | Bin 1157099 -> 1235832 bytes grafana/rmf-app/doc/src/prereq_plugin.dita | 25 ++ .../doc/src/prometheus_sample_dashboards.dita | 66 ---- .../rmf-app/doc/src/prometheus_sample_db.dita | 64 ++++ grafana/rmf-app/doc/src/rmf_grafana.ditamap | 17 +- grafana/rmf-app/doc/src/rn.dita | 33 +- .../doc/src/templates/pdf-template/pdf.opt | 17 - grafana/rmf-app/doc/src/update_plugin.dita | 140 +++++--- grafana/rmf-app/doc/src/visual_grafana.dita | 4 +- 73 files changed, 3354 insertions(+), 1181 deletions(-) create mode 100644 docs/grafana/rmf-app/dashboards_overview.html delete mode 100644 docs/grafana/rmf-app/images/app_section.png create mode 100644 docs/grafana/rmf-app/install_grafana_plugin_legacy.html create mode 100644 docs/grafana/rmf-app/install_plugin_cli.html create mode 100644 docs/grafana/rmf-app/install_plugin_docker.html create mode 100644 docs/grafana/rmf-app/install_plugin_ui.html create mode 100644 docs/grafana/rmf-app/install_sample_dashboards.html create mode 100644 docs/grafana/rmf-app/oxygen-webhelp/app/nav-links/json/dashboards_overview-d526e164.js rename docs/grafana/rmf-app/oxygen-webhelp/app/nav-links/json/{grafana_via_zosmf-d423e208.js => grafana_via_zosmf-d526e318.js} (81%) create mode 100644 docs/grafana/rmf-app/oxygen-webhelp/app/nav-links/json/install_grafana_plugin-d526e60.js rename docs/grafana/rmf-app/oxygen-webhelp/app/nav-links/json/{prereq_zosmf-d423e227.js => prereq_zosmf-d526e337.js} (73%) create mode 100644 docs/grafana/rmf-app/prereq_plugin.html delete mode 100644 docs/grafana/rmf-app/prometheus_sample_dashboards.html create mode 100644 docs/grafana/rmf-app/prometheus_sample_db.html create mode 100644 grafana/rmf-app/doc/src/dashboards_overview.dita create mode 100644 grafana/rmf-app/doc/src/install_grafana_plugin_legacy.dita create mode 100644 grafana/rmf-app/doc/src/install_plugin_cli.dita create mode 100644 grafana/rmf-app/doc/src/install_plugin_docker.dita create mode 100644 grafana/rmf-app/doc/src/install_plugin_ui.dita create mode 100644 grafana/rmf-app/doc/src/install_sample_dashboards.dita create mode 100644 grafana/rmf-app/doc/src/prereq_plugin.dita delete mode 100644 grafana/rmf-app/doc/src/prometheus_sample_dashboards.dita create mode 100644 grafana/rmf-app/doc/src/prometheus_sample_db.dita diff --git a/docs/grafana/rmf-app/access_grafana_zosmf.html b/docs/grafana/rmf-app/access_grafana_zosmf.html index d9e6dcc3..c8ca9101 100644 --- a/docs/grafana/rmf-app/access_grafana_zosmf.html +++ b/docs/grafana/rmf-app/access_grafana_zosmf.html @@ -1,13 +1,13 @@ - Accessing the Grafana dashboard + Accessing the Grafana dashboard - + - + @@ -110,7 +110,7 @@ @@ -145,11 +145,17 @@

Accessing the Gra Click OK.

Results

You have accessed Grafana from z/OSMF.
-

What to do next

You can perform the following tasks:
    -
  • View the dashboards by navigating to Apps > IBM RMF > Dashboards.
    • -
  • Add a RMF data source to fetch data from Distributed Data Servers (DDS). See Creating RMF data - sources.
    • -
+

What to do next

+
    +
  • +

    View the dashboards by navigating to Apps > IBM RMF > Dashboards.

    +
    • +
  • +

    Add a RMF data source to fetch data from Distributed Data Servers (DDS). See Creating RMF data + sources.

    +
    • +
+
diff --git a/docs/grafana/rmf-app/alerts.html b/docs/grafana/rmf-app/alerts.html index 41d16e09..c1938bcf 100644 --- a/docs/grafana/rmf-app/alerts.html +++ b/docs/grafana/rmf-app/alerts.html @@ -1,13 +1,13 @@ - - Introduction to Alerts + + Introduction to Alerts - + - + @@ -85,7 +85,7 @@
- +
@@ -109,7 +109,7 @@ diff --git a/docs/grafana/rmf-app/apply_visualize.html b/docs/grafana/rmf-app/apply_visualize.html index 75e08bca..b786e818 100644 --- a/docs/grafana/rmf-app/apply_visualize.html +++ b/docs/grafana/rmf-app/apply_visualize.html @@ -1,13 +1,13 @@ - - Applying visualization to RMF data + + Applying visualization to RMF data - + - + @@ -85,7 +85,7 @@
- +
@@ -109,7 +109,7 @@ @@ -129,11 +129,17 @@

Applying visualiz

By adding panels to dashboards, you can effectively present your RMF data in a visual format. Each panel must require at least one query to display a significant visualization.

-

Before you begin

You must have completed the following tasks: +

Procedure

  1. Identify the dashboard for which you want to add visualization.
  2. @@ -154,8 +160,8 @@

    Applying visualiz Click + Add visualization to add visualization to your data.
    -
    Note: The navigation of the user interface can differ based on the - Grafana version that is currently installed.
    +
    Note: The navigation of the Grafana user interface can differ + based on the Grafana version that is currently installed.
    The Edit panel is displayed.

  3. diff --git a/docs/grafana/rmf-app/context-help-map.xml b/docs/grafana/rmf-app/context-help-map.xml index 7f5b4521..4f923bcc 100644 --- a/docs/grafana/rmf-app/context-help-map.xml +++ b/docs/grafana/rmf-app/context-help-map.xml @@ -2,16 +2,24 @@ + + + + + - + + + + + - - diff --git a/docs/grafana/rmf-app/create_datasources.html b/docs/grafana/rmf-app/create_datasources.html index ba7b51ed..29d16c06 100644 --- a/docs/grafana/rmf-app/create_datasources.html +++ b/docs/grafana/rmf-app/create_datasources.html @@ -1,13 +1,13 @@ - - Creating RMF data sources + + Creating RMF data sources - + - + @@ -85,8 +85,8 @@
    - -
    + +
@@ -109,7 +109,7 @@ @@ -130,14 +130,14 @@

Creating RMF data adding an RMF data source.

Before you begin

Procedure

  1. Go to Apps > IBM RMF > Add RMF Data Source. -
    Alternatively, you can click Administration > Data sources > + Add new data source, then search for the IBM RMF to choose a data source type.
    Note: The navigation of the user interface can differ based on the - Grafana version that is currently installed.
    +
    Alternatively, you can click Administration > Data sources > + Add new data source, then search for the IBM RMF to choose a data source type.
    Note: The navigation of the Grafana user interface can differ + based on the Grafana version that is currently installed.
  2. Enter a name for the data source in the Name field. diff --git a/docs/grafana/rmf-app/dashboards_overview.html b/docs/grafana/rmf-app/dashboards_overview.html new file mode 100644 index 00000000..947c0814 --- /dev/null +++ b/docs/grafana/rmf-app/dashboards_overview.html @@ -0,0 +1,185 @@ + + + Dashboards + + + + + + + + + + + + + + Jump to main content + + + + + +
    + +
    +
    + + +
    +
    + + +
    IBM RMF for z/OS Grafana Plugin
    + +
    + + + +
    + + + + + + + +
    +
    +
    + + + + +
    + + + + + + + +
    + +
    +
    + + +
    + + + + +
    +
    + + + + +
    + + + +
    +

    Dashboards

    + + +

    The IBM RMF for z/OS Grafana plugin provides pre-built sample + dashboards that you can install, as well as the ability to import dashboards from other + sources and integrate with IBM Z OMEGAMON dashboards.

    +

    After you install the plugin, you can deploy sample dashboards to visualize RMF for z/OS metrics. The plugin offers the following + dashboard categories:

    +
      +
    • +

      DDS Sample Dashboards - A comprehensive set of dashboards + for visualizing RMF Monitor III metrics collected through the Distributed Data Server. These dashboards are installed into + a dedicated folder named IBM RMF (DDS).

      +
      • +
    • Prometheus Sample Dashboards - Dashboards designed to work + with Prometheus-compatible platforms that scrape metrics from the RMF DDS + /metrics/m3 endpoint. These are installed into a folder named + IBM RMF (Prometheus).
      • +
    • Imported Dashboards from RMF Performance Monitoring - + Dashboards exported from RMF Performance Monitoring can be imported into the plugin. + These are placed in a folder named IBM RMF (PM).
      • +
    +

    You can also integrate DDS dashboards with IBM Z OMEGAMON Web UI dashboards for enhanced visibility across both tools.

    +
    +
    + + + + + + +
    + +
    +
    + + + +
    +
    +
    + +
    +
    + +
    + +
    + + + + + + + \ No newline at end of file diff --git a/docs/grafana/rmf-app/define_grafana_zosmf.html b/docs/grafana/rmf-app/define_grafana_zosmf.html index c1692132..14173170 100644 --- a/docs/grafana/rmf-app/define_grafana_zosmf.html +++ b/docs/grafana/rmf-app/define_grafana_zosmf.html @@ -1,13 +1,13 @@ - Defining the Grafana server + Defining the Grafana server - + - + @@ -110,7 +110,7 @@ @@ -129,10 +129,16 @@

    Defining the Graf

    You must define the Grafana server as a target system in z/OSMF to access Grafana from the Resource Monitoring page of z/OSMF.

    -

    Before you begin

    You must have completed the following tasks:
    +

    Before you begin

    + +

    Procedure

    1. Enter the URL of z/OSMF in a web browser.
    2. @@ -193,12 +199,18 @@

      Defining the Graf

    Results

    You have defined the Grafana server as the target system.
    -

    What to do next

    You can perform the following tasks:
      -
    • Modify or Remove the Grafana server by clicking the - Action drop-down menu from the System - Status page.
      • -
    • Access Grafana dashboards. See Accessing the Grafana dashboard.
      • -
    +

    What to do next

    +
      +
    • +

      Modify or Remove the Grafana server by clicking the + Action drop-down menu from the System + Status page.

      +
      • +
    • +

      Access Grafana dashboards. See Accessing the Grafana dashboard.

      +
      • +
    +
    diff --git a/docs/grafana/rmf-app/error_reports.html b/docs/grafana/rmf-app/error_reports.html index 18a251a6..800f087f 100644 --- a/docs/grafana/rmf-app/error_reports.html +++ b/docs/grafana/rmf-app/error_reports.html @@ -1,13 +1,13 @@ - Error reporting in the plugin + Error reporting in the plugin - + - + @@ -109,7 +109,7 @@ diff --git a/docs/grafana/rmf-app/grafana_config_parms.html b/docs/grafana/rmf-app/grafana_config_parms.html index 30b74362..dec17202 100644 --- a/docs/grafana/rmf-app/grafana_config_parms.html +++ b/docs/grafana/rmf-app/grafana_config_parms.html @@ -1,13 +1,13 @@ - Grafana configuration parameters + Grafana configuration parameters - + - + @@ -107,7 +107,7 @@ @@ -126,118 +126,130 @@

    Grafana configura

    You can find the information about parameters you can use during the configuration of JWT authentication on Grafana.

    -

    The following table lists the minimum parameters that you must configure to enable JWT +

    The following tables lists the minimum parameters that you must configure to enable JWT authentication on Grafana:

    -
    +
    - - - - + + + - - - + - + - - + - + - - + - + - - + - + - - + - + - - + - + - - + - + - - + - + - - + - + +
    Table 1. [auth.jwt] Parameters
    SectionParametersDescriptionValues to be configured for z/OSMFParametersDescriptionValues to be configured for z/OSMF
    [auth.jwt]enabledUse this parameter to allow JWT to authenticate on the Grafana + enabledUse this parameter to allow JWT to authenticate on the Grafana server.

    The default value is set to true.

    		truetrue
    enable_login_tokenUpon successful authentication proxy header validation, this + enable_login_tokenUpon successful authentication proxy header validation, this parameter provides the user with a login token.

    The default value is set to false.

    		truetrue
    header_nameUse this parameter to specify the header's name that holds a + header_nameUse this parameter to specify the header's name that holds a token.

    The default value is set to X-JWT-Assertion.

    		X-Forwarded-Access-TokenX-Forwarded-Access-Token
    username_claimUse this parameter to identify the user. + username_claimUse this parameter to identify the user.

    The sub claim is mandatory and needs to be present in a JWT, and it should mention the subject of the JWT.

    The default value is also set to sub.

    		subsub
    jwk_set_fileUse this parameter to verify the token with a JSON Web Key Set loaded + jwk_set_fileUse this parameter to verify the token with a JSON Web Key Set loaded from a JSON file./PATH/TO/jwks.json/PATH/TO/jwks.json
    cache_ttlUse this parameter to establish the duration for caching data + cache_ttlUse this parameter to establish the duration for caching data retrieved from the HTTP endpoint.

    This parameter enables the user to store the data for a specified period, allowing for faster access and retrieval of information.

    The default value is set to 60m (minutes).

    		60m60m
    expect_claimsUse this parameter to verify the validity of other claims that + expect_claimsUse this parameter to verify the validity of other claims that contain JSON-encoded information.

    When it comes to validation, only the exp, nbf, and iat claims are automatically checked by default.

    You must validate if you are using other claims such as iss, sub, aud, and jti.

    		{"iss": "zOSMF"}{"iss": "zOSMF"}
    auto_sign_upUse this parameter to automatically create user profiles in Grafana + auto_sign_upUse this parameter to automatically create user profiles in Grafana using the TSO ID of z/OSMF for users who do not have user profiles in the Grafana server.

    The default value is set to false.

    		truetrue
    url_loginUse this parameter to enable JWT authentication in the URL. + url_loginUse this parameter to enable JWT authentication in the URL.

    The default value is set to false.

    		truetrue
    +
    + + + + + + - - - + - + - - + - + - - + - + +
    Table 2. [server] Parameters
    ParametersDescriptionValues to be configured for z/OSMF
    [server]protocolUse this parameter to configure z/OSMF to work over + protocolUse this parameter to configure z/OSMF to work over HTTPS.

    When you configure z/OSMF to work over HTTPS, it is recommended to configure Grafana to also work over HTTPS. This ensures the secure data transfer between the user's web browser and the Grafana server.

    The default value is set to http.

    		httpshttps
    cert_fileUse this parameter to specify the path to the certificate file when + cert_fileUse this parameter to specify the path to the certificate file when the protocol parameter is set to https or h2./PATH/TO/certificate.crt/PATH/TO/certificate.crt
    cert_keyUse this parameter to specify the path to the certificate key file + cert_keyUse this parameter to specify the path to the certificate key file when the protocol parameter is set to https or h2./PATH/TO/privateKey.key/PATH/TO/privateKey.key
    +
    + + + + + + - - - + - + - - + - + - - + - +

    The default value is set to false.

    +
    Table 3. [Security] Parameters
    ParametersDescriptionValues to be configured for z/OSMF
    [Security]cookie_secureUse this parameter if you hosted the Grafana instance over + cookie_secureUse this parameter if you hosted the Grafana instance over HTTPS.

    The default value is set to false.

    		truetrue
    cookie_samesiteUse this parameter to prevent the browser from sharing cookies with + cookie_samesiteUse this parameter to prevent the browser from sharing cookies with other websites.

    The default value is set to lax.

    		disableddisabled
    allow_embeddingUse this parameter to enable web browsers to display Grafana within + allow_embeddingUse this parameter to enable web browsers to display Grafana within z/OSMF HTML <frame>, <iframe>, <embed>, or <object> element. -

    The default value is set to false.

    		truetrue

    For more information about customizing the Grafana instance by modifying the parameters diff --git a/docs/grafana/rmf-app/grafana_via_zosmf.html b/docs/grafana/rmf-app/grafana_via_zosmf.html index 2acb1244..b05a51a4 100644 --- a/docs/grafana/rmf-app/grafana_via_zosmf.html +++ b/docs/grafana/rmf-app/grafana_via_zosmf.html @@ -1,13 +1,13 @@ - Grafana through IBM z/OS Management Facility + Grafana through IBM z/OS Management Facility - + - + @@ -109,7 +109,7 @@

    @@ -143,7 +143,7 @@

    Grafana through < Install the RMF for z/OS plugin on Grafana. - Installing the RMF for z/OS plugin on Grafana + Installing the RMF for z/OS Grafana plugin v2.0.1 or later Define Grafana servers as target systems. diff --git a/docs/grafana/rmf-app/historical_data.html b/docs/grafana/rmf-app/historical_data.html index a4b6ae03..badb1bc7 100644 --- a/docs/grafana/rmf-app/historical_data.html +++ b/docs/grafana/rmf-app/historical_data.html @@ -1,13 +1,13 @@ - Historical data collection + Historical data collection - + - + @@ -109,7 +109,7 @@ diff --git a/docs/grafana/rmf-app/images/app_section.png b/docs/grafana/rmf-app/images/app_section.png deleted file mode 100644 index b32f6f88cb7f22a7a78b0fe6a3aca7b00c1ccac0..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 8429 zcmb`NcT^K?yY6X9m-Z?kNI;rM2_2;c5TuL3D;+`!f+$6bAcTabh=5>_Ce4Bn1z4torIqU3ozCW^NCX+SKtauZ8jhMAk4%hae9ta9sB!JOGU?^+ zsB|&0E4jB?WFGZ|Gqlq%>x^x?JTL@Wvu@Aox$8zMLz@6ANkBQ7NH(@gHiePFKrvxuR!) z<$6wPqjyuAX{?AbPdWpy2h}Ap(fAO%jA`9449gvZ{1cfC#c;OyFhli4 zFA8+t;M5ShAl~?48cvE3!DL8$n4?T>9=%Reojc+Fh2S&`o}lO#Pm}e3EZU9h@M0?I zxdy0usDfT3)d-?Uah0(Y|B%9cP)xNECz@9fK9Lg+Gg`1P)N#o*z)?z7s%ze?jJh&H z_ksuFsVVtEk|F-`n#Wp#BDe!KXH61q>==TB(v{DQ9%Ss7rlwbFe7$yYY4R#9l56k>qE$OD$hSR@fvAv_OahX9`l}X#t(G%7o;0l*! zrGO0ZW5cuRc|x4~5Mm?dC;D7Gg~(-K*e7|zMO4^VuvFF`S&|}xNf52N)lDw@5Pfa& zVxj3v0r*s|mO+E_%?2iKqC-sMY1R-IXKsxW`TJrY3Oo%Oo>fI94fOWH4T3wi@MndL z%1{vzZ#3*_uy_4L^YEf7)?e9qA@i8p)&tadP6&uj>m&+L|lfLP-adNsX2X+(DC;mCDZSzX)KGC21<$SOhGxVOACP1=y=sjEIAlA~_@aX}I(1BhznWEr#SN4i`js{Ukx7imx z+KW8wNlYp&u7|B^wBB32sI)8Q&OyN1ppnU&_5m+*=`?-4W0xNV4s zIUc!pqIs4*PqLzUS4OGC!02LL^LK@JnUQN5Sc#tn<_4xoYuDwQu*VANBB)kjk0(8o zd%5fs;P#&RG&!l#^_aP&G zYNellMj<7#>z088yZim-M&txa>4%M9ngO%BQ+x|}s51|QWzmYF*7`)Ym5VMCiEA++ z&EygWoUn&S!*&0|ljg&iVZE0~OKkHK1KBHW#^t$5)`Bp~PzmUgNz9K)rHzM_g&!h2 z;s@QYNX5?~k2K=VehKB}?{I7i3qy=JIibMw*-X)C4d8iY)Z0Ybfm8($LFPp zi|oD}Bn#__e;^Ul$&0i(Gt_BBHzR2Fa6x-2XMHL1*(TNbPuLojXVHg>@}K4}7V!=%d2iYPZ1a#@7bbe*!%rf4FKBPu>4IT(B6}_wVkVxc#6e_#kMg-5#j z`+5{J3U2k8s@MW^_{Ck|UHhygsQ+_G&SHkm`mrsFA&+_CW6id3i?}zTrj?dgs`1P9 zM{X-4{kNt{sT<;Y>An`JCJyb+-FwvX4R3qGcEMCfs@rqbEh2*1j?nE?4Bll*B5ze* zV8r|_^=jd}R6_r-+kK+HAKS88dV{PArDo~qW~`j3M>8iUZGk*>+2g9Zv9>f4)uExD zv}A0xv*ac{|Fx9)iVOTY@S^XWa@e$Emcg4U6uO88F8wml!nwLF6Iz-gc$tY#xE0M! z_0sn|`acmGz%MXsvHWz|!n`?4SGgPkr-p4P?tFr`L$H$N% zZ^w@utCE#9bKfY8gOeK{wk-<#t^MC4j{oz*5Ww~2hR+@n9}@@>iZxa4M@&ZFyr~rC ze2}dcv{xG{tVQfmdnXINlTH<F*E|87eu*9Flu02%bX_G`Oh``56!opE)MzJ3;rH3 z3a2=2RPE5mt4tXlT%`*ef7AADB-q7a2v+XE%^Akct@0_DOYKQt_rN;)eP)QC%H; zRzA)md2G#f@gj14s^dGH88fD?&2(Zu3Gwmq^uH9?5|CO<=`P1U4R70c-`90Ym{zBf z00=yYRf%YbblKGKuex_Z5nN6eZ^4q$ayTwd=0Eo6 z>wHK8X|aY)1R(!1q;u`%`pnsk!ALwALo1nhzmlk>;{swMGEQQEAOC~Y|6dX4A5X?X ziCnY=amHrFVf>dbms+Xas8O-6VvPz;> zvmK&_XRT%5raH-4Gwo|1v<>JQc5*Y>?lb5~rPntJ4n;>j)1U3>c4}~I9_efomx=idkuQT< z?l2k_Fqpi#3NNuu?VAAid{eknEK~$H8NH_?rH(BH986A64ymTY$ccJX*NEcOzy~W+ zO}k%TafIC8O^v3)c17xYKFkQB^Q+zI!f0_dS|>Um8lc#j*@)Ek(YN#8ebM{9 z%D16ZxirRso;Ttwe;qu{wjyH(#|C1)6b=ceo&h?K;RZV-ubt`;d-^)lNLu7c$*gvL zGizbMzMf5ivu-@As}F*Co)&lJTRz(q5kbTbB6O6w{;^vBUtQ*Z(tOTJ(k=87{|j!i}YM_ zSV_4lT!s#h*+C)}W3k^P`Q8g>q*w?FM}6|gzwJ6V2@eQhwK*>M13MPz>rBLA7WV3* zJTu<~GWP77!g0Rp3p5nRsF#$HBDt>5y^`wO61JB{T?UGHEUl{ayR5j8zO`*h%`XQ) znxkRzfRUgmYYE@%!TN0}8NCOtScr|I*DGdTa002@U{qSLG2hsF6rrGDQcA4PC`>Z# zsanaFr@me|xLi>mG;+D@dK0#5(`m?-Uqba^!U<-Ijr3F>g7PK~^o8%Y;WB><=94lr zFC&7G^f-!D6Z-!ELs0BZdA3YsjsKQ_GeUN+P?jX9-v)T$B`@RZes5S{GAvm<^9v6C1dXb^uFz}KQ)Svwb; zF^Uy4O%AhpR^H9as7e{*6R;Y;QK{|9{uP|emE}|O_?UBPyVxqJuHnVPR}1y*B)ljS zky@-};l~PK!QV~AS#k?K(GS3Jm1n&FFG1J;hd4uVd;Q%3du}urKpM^oLL$5SRh0h8 z+j31?CK~T}>nnCIn7qGvLvd5!w!zGzGqN-1@k;^6_p8F9y32(1AuBE$7Nxwp7w{ar)WIPS<8+B0WZq*NNn zNHs;pOHjEg7j-1-ZgKaZQEyAd<+L6@z1hXAap6tFV|>FFp+4j`tUoW&^X`hmn%n43 z+q~L#ix6GCLN=efLzu!+WE&@@yaNH)hL%WKcC zV|?h!xFXag*SK@K*ZS9507)kd?e6ehX%d6ibb&_id;)j;Y&k*p)oF+lB zc#O#HV4J}DeXF#q9G_0sIA|rr0Z{q--Gg+B%EFb+(18f=_t^zn&L+=E-Nxqfem?y92Z0$7EbMv#as34iq(t(AB?9YT zC8o5;{u*6Bc(#peX-WER=T2VaBuIC^HPDWi0c??M0e)gT|E2=*sn_ghE^)~O(&1O_ zg|0uX;6bcQOP{KM(QdyjF4O7)hFI|%D0e4OG12f83`+m*le!Dkm!ySTdFc>X{qU1$pjU9P7QtoH z*zF%}qfQO-@o5v_5g#8BeVJ+MmPmmMsk4Vow+!GKvZ$qhbpgO-Ww6_Mo z6&Fe+?>?wpr;wBNO`U%H$pW4v>VMK9e2(dAY#LJ!{yT`7GdPyI!r!NFTfXJ;6<&Ki zNB4-grR{MsXi#^e)eU<~rNSIgGLvgKg~${e2A^bm{}&loJYHAjJ?$OnEcU(+Fw;bQ zC1_@sCwz5G!x2H%VO*wWXkgF&oV3tctmZrW@%?_fQas?QRf*4yrN@QBC<}CjL2qi- z^swSEf31Iqg?Pq6tlsM`laIy-|D1#Z$X=grGNi7^SH{8l1z!pAvij=l;2Ti2;ETqn zc+a9=aB%7ePgAzW@_HoPzw~u{{sJU)CQayq`)lEUoYjeS`G-9S5sl(_-4zPD*GEU8M!wRNmf{ zPvGp%QgyVleV2be(pRTSDL0$>;w#<9Igl^cZ;f7qRrs+x z8l`yTfAVK9Ji=&sFo&9{W08$ZQkqXxYt77x&qiDkXAeCBs;cKR&?-|YY_Df?v!Q|c zj-Dn|*519=3p(Y^nlF@~O%W|4qu-i+&-tIH7Pu_`g8j#&2Fvktt=`|36@ke6>XZvxH6lXYgtxq#J5 z)4Dx&)P2Nu=c$ior zES`HVT1MGzi9U-QsW7KpLH8?uO^g*Xl(-nrM?nuW^{^k(0I{(9eGEb}Hrb9>XN=j0 zNNuTUUJI%w+_%!)rr8nCm21Ls1Jj8Kb`Hka5ZF1Jb)B0R9D$v2T`!1G=K24A%>JJM z=wAVSU*|+_CR9Wl$WWZ2mN}bx3PPI})B7LCHK?!#^N(ID^J0)Mk9U$=8DaQGVH8Y9WAKH0FXt&zLp6qd;$;3~8;TKIVEau_7A694RdH-{ z#Wx&cRwnR~mB#kI0e4EC+eFCJUi#Cc*@RUmgNdeo4{%<|0X}A-R2Xbt33I{f3 zx7-Hu{!y{=XB^=4{mzGA0V} z=&XtTPG@gECL6RNti7+(8aQE9#%bikuZh2~)b!;(2~Ng5(t2Q7qE2U73Ed^(75Oyd zNa=bts~~Ba<+3I#p*Z7Q5P1V8+pk2$$WhNcn$|GsiA9G6@< z5llpfP+Qm3kCQkBg&}0!s%BuVd;fNU&?pWhLcZq~b#zXc8A$zGwCKOSW%~#C_&Ett zRj$U+u)``A`pB8p#1Em<$KLR&s=%vJ3x_Fo@~n==CQsSK{)8Zu(*(zBnh2z!eHzUD zBuVkPG$XY_PEv5|G@@IBGpiEiE&Dzn_c7(DeQDUj;`4}0$l5&sUM+`d`pPPq%yl=W z(o)1P%BUOOF@>Zfb(cEm_ujei!hS7yQTVK~FTQ?QRe7>-^Df~2MjGapcaP1y5ggbq zbi`j@HjyxlU*Q0`ZnhYwa5v zT>>7j99@wQZ7xP;OzH;_yEqgT9pBiMPm=+#68u{9E$Xc$chhy6Gb;magO!0ska(96 zr*KB#0y|Cr*233{VgGqz0_leCw@=DIJgL&f_}Nm~(r9B~q7fuVkYdcsYYqIQ7OgEs zquV)+;F`}3{-ubve-b40R7K;Dx_;YQ(z1Ek{^Z4Fj?q}`lp$) zS%caPdYaJ<*9;B z1JTeHBgQ=*zm!U>KD=pBp5~~;4S8qR+5e^bd-fk>9_s78bQ@TKKVc@Zn0qh-@=X6r z1)d{Mx1=cZQ`pQhyDMW3t$E>JPkU{z0+A){SO-GU?So&?f~KWqUn`vp-LPZ?hW#>i zJ{k>jPjy6tsGGhu*cznVr~3|hYVgNC@P{NEMOBl6$LgigHv(2}gaqa7RUUGD{SO - - Importing Dashboards created in RMF Performance Monitoring + + Importing dashboards created in RMF Performance Monitoring - + - + @@ -77,7 +77,7 @@

    @@ -109,7 +110,7 @@ @@ -124,39 +125,77 @@
    -

    Importing Dashboards created in RMF Performance Monitoring

    +

    Importing dashboards created in RMF Performance Monitoring

    -

    This task describes how to import dashboards and the associated data sources created - in RMF Performance Monitoring in the RMF application.

    +

    You can import dashboards exported from RMF Performance Monitoring + (.po files) into the IBM RMF for z/OS Grafana plugin. The import process automatically + creates the associated data sources and converts the dashboards to Grafana format.

    Before you begin

    -
    You must have completed the following task:
    +

    About this task

    +

    When you import a .po file, the plugin performs the following + actions:

    +
      +
    • Parses the data source definitions from the file and creates the corresponding + IBM RMF data sources in Grafana if they do not already exist.
      • +
    • Converts the Performance Monitoring dashboard panels into Grafana bar chart + panels with appropriate queries and transformations.
      • +
    • Installs the converted dashboard into the IBM RMF + (PM) folder.
      • +
    +

    Procedure

    1. - Go to Apps > IBM RMF and navigate to the Import Dashboards from RMF Performance - Monitoring section. + Go to Apps > IBM RMF and navigate to the Import Dashboards from RMF + Performance Monitoring section.
    2. Verify the Destination folder path displayed under the section heading. +
      +

      The imported dashboards are placed in the IBM RMF + (PM) folder.

      +
    3. - Click Go to PM Dashboards to review existing RMF - Performance Monitoring dashboard files before importing. -
    4. - In the Upload File area, drag and drop - .po dashboard file or click the upload zone to browse - for the file manually. + Drag and drop a .po dashboard file onto the drop zone, or + click the drop zone to browse for the file manually. +
      +

      Only files with the .po extension are accepted. You can + import one file at a time.

      +
      +
      The plugin automatically creates any required data sources and imports + the dashboard into the destination folder. A success notification confirms the + import with the dashboard name.
      +
    5. Optional: + Click Go to PM Dashboards to navigate to the + destination folder and review the imported dashboards. +
      +

      This button is available only after at least one dashboard has been + imported.

      +
      +
    6. Optional: + To remove all imported dashboards, click + Delete.
      -
      Note: The Data sources defined in RMF Performance - Monitoring dashboards are imported without credentials. After import, update - each data source with valid credentials if the DDS requires authentication - where required.
      +

      This removes the IBM RMF (PM) folder and all + dashboards within it. The data sources created during import are not + removed.

    Results

    -

    The dashboards exported from the RMF Performance Monitoring are successfully imported - into the RMF application.

    +

    The dashboard exported from RMF Performance Monitoring is successfully imported into + the IBM RMF for z/OS Grafana plugin and is available in the + IBM RMF (PM) folder.

    +
    Important: Data sources defined in RMF Performance + Monitoring dashboards are imported without credentials. After import, update each + data source with valid credentials if the corresponding DDS requires + authentication.
    diff --git a/docs/grafana/rmf-app/index.html b/docs/grafana/rmf-app/index.html index 02693402..c91225c0 100644 --- a/docs/grafana/rmf-app/index.html +++ b/docs/grafana/rmf-app/index.html @@ -8,9 +8,9 @@ - + - + @@ -92,7 +92,7 @@
    -
    Overview
    Grafana is a platform for monitoring and visualizing data. It enables users to create, explore, and share dashboards that are interactive and customizable. The IBM® RMF for z/OS Grafana plugin provides effortless analysis and visualization of Resource Measurement Facility for z/OS (RMF for z/OS) Monitor III metrics and reports within the Grafana platform. Thereby, you can monitor and analyze the health and performance of applications.
    Release notes
    This article covers the new features, system requirements, and known issues of the IBM® RMF for z/OS Grafana plugin.
    Installing the plugin
    You must install the IBM® RMF for z/OS Grafana plugin to analyze and visualize RMF Monitor III metrics and reports.
    Upgrading the plugin
    You must ensure that the IBM RMF for z/OS Grafana plugin is up to date to leverage its enhanced functionalities. You can do so by either installing or upgrading to the latest version of the plugin.
    Prometheus Sample Dashboards
    The RMF Distributed Data Server exposes Monitor III data to third-party tools using the OpenMetrics exposition format.
    Creating RMF data sources
    To access RMF Monitor III metrics in Grafana, you need to connect to the Distributed Data Server (DDS) by adding an RMF data source.
    Applying visualization to RMF data
    By adding panels to dashboards, you can effectively present your RMF data in a visual format. Each panel must require at least one query to display a significant visualization.
    IBM RMF query languages
    In Grafana, queries are essential for fetching and transforming data from RMF data sources.
    RMF Variable Query syntax
    Variables are a powerful tool to create more interactive and dynamic dashboards. They offer a way to replace hard-coded values in metric queries and panel titles with placeholders for values.
    Integrating DDS Dashboards with OMEGAMON
    To enhance visibility and provide deeper insights, the DDS dashboards can be integrated with IBM Z OMEGAMON Web UI dashboards.
    Importing dashboards
    This task describes how to import dashboards and the associated data sources created in RMF Performance Monitoring in the RMF application.
    Alerts
    Grafana Alerting feature provides a reliable solution to detect and respond to system issues in real time.
    Historical data
    In Grafana, you can view historical data using absolute and relative time ranges.
    Error types
    Whenever you encounter issues while using the IBM RMF for z/OS Grafana plugin, you can view detailed error messages that contain sufficient information to help you identify and troubleshoot the problem.
    Troubleshooting issues
    This section guides how to analyze and address typical issues that may arise when using the IBM® RMF for z/OS Grafana plugin.
    Grafana through z/OSMF
    When you use IBM® z/OS Management Facility to monitor the performance of the z/OS sysplexes in your environment, you can also access Grafana dashboards from z/OSMF.
    Prerequisites
    Before you can start working with Grafana dashboards through z/OSMF, there are some prerequisites that you need to complete.
    Defining the Grafana server
    You must define the Grafana server as a target system in z/OSMF to access Grafana from the Resource Monitoring page of z/OSMF.
    Accessing the Grafana dashboard
    You can access the Grafana dashboard from the Resource Monitoring page of z/OSMF to investigate the RMF Monitor III metrics and reports.
    PDF Guide
    You can find the link to view or download IBM RMF for z/OS Grafana plugin user guide as a PDF file.
    +
    Overview
    Grafana is a platform for monitoring and visualizing data. It enables users to create, explore, and share dashboards that are interactive and customizable. The IBM® RMF for z/OS Grafana plugin provides effortless analysis and visualization of Resource Measurement Facility for z/OS (RMF for z/OS) Monitor III metrics and reports within the Grafana platform. Thereby, you can monitor and analyze the health and performance of applications.
    Release notes
    This article covers the new features and enhancements in the IBM RMF for z/OS Grafana plugin.
    Prerequisites
    Before you install the RMF for z/OS Grafana plugin, ensure that the following software requirements are met.
    Installation
    You must install the RMF for z/OS Grafana plugin to analyze and visualize RMF Monitor III metrics and reports.
    Installing the plugin by using Grafana UI
    This is the easiest and recommended method to install the RMF for z/OS Grafana plugin. You can install the plugin directly from the Grafana plugin catalog by using the Grafana web interface without requiring command-line access.
    Installing the plugin by using Grafana CLI
    You can install the RMF for z/OS Grafana plugin by using the Grafana command-line interface. Use this method if you need to install a specific version or automate the installation.
    Installing the plugin by using Docker
    You can install the RMF for z/OS Grafana plugin along with Grafana within a Docker container. Use this method if you are running Grafana in a containerized environment.
    Installing the plugin v2.0.0 or earlier
    If you are installing a version of the RMF for z/OS Grafana plugin earlier than 2.0.1, you must configure Grafana to allow loading unsigned plugins.
    Upgrading the plugin
    You must ensure that the RMF for z/OS Grafana plugin is up to date to leverage its enhanced functionalities. You can do so by either installing or upgrading to the latest version of the RMF for z/OS Grafana plugin.
    Creating RMF data sources
    To access RMF Monitor III metrics in Grafana, you need to connect to the Distributed Data Server (DDS) by adding an RMF data source.
    Dashboards
    The IBM RMF for z/OS Grafana plugin provides pre-built sample dashboards that you can install, as well as the ability to import dashboards from other sources and integrate with IBM Z OMEGAMON dashboards.
    Installing sample dashboards
    After you install and enable the IBM RMF for z/OS Grafana plugin, you can install the DDS sample dashboards and Prometheus sample dashboards to visualize RMF metrics.
    Prometheus sample dashboards
    The RMF Distributed Data Server exposes Monitor III data to third-party tools using the OpenMetrics exposition format.
    Integrating DDS dashboards with OMEGAMON Web UI
    To enhance visibility and provide deeper insights, the DDS dashboards can be integrated with IBM Z OMEGAMON Web UI dashboards.
    Importing Performance Monitoring dashboards
    You can import dashboards exported from RMF Performance Monitoring (.po files) into the IBM RMF for z/OS Grafana plugin. The import process automatically creates the associated data sources and converts the dashboards to Grafana format.
    Applying visualization to RMF data
    By adding panels to dashboards, you can effectively present your RMF data in a visual format. Each panel must require at least one query to display a significant visualization.
    IBM RMF query languages
    In Grafana, queries are essential for fetching and transforming data from RMF data sources.
    RMF Variable Query syntax
    Variables are a powerful tool to create more interactive and dynamic dashboards. They offer a way to replace hard-coded values in metric queries and panel titles with placeholders for values.
    Alerts
    Grafana Alerting feature provides a reliable solution to detect and respond to system issues in real time.
    Historical data
    In Grafana, you can view historical data using absolute and relative time ranges.
    Error types
    Whenever you encounter issues while using the IBM RMF for z/OS Grafana plugin, you can view detailed error messages that contain sufficient information to help you identify and troubleshoot the problem.
    Troubleshooting issues
    This section guides how to analyze and address typical issues that may arise when using the IBM® RMF for z/OS Grafana plugin.
    Grafana through z/OSMF
    When you use IBM® z/OS Management Facility to monitor the performance of the z/OS sysplexes in your environment, you can also access Grafana dashboards from z/OSMF.
    Prerequisites
    Before you can start working with Grafana dashboards through z/OSMF, there are some prerequisites that you need to complete.
    Defining the Grafana server
    You must define the Grafana server as a target system in z/OSMF to access Grafana from the Resource Monitoring page of z/OSMF.
    Accessing the Grafana dashboard
    You can access the Grafana dashboard from the Resource Monitoring page of z/OSMF to investigate the RMF Monitor III metrics and reports.
    PDF Guide
    You can find the link to view or download IBM RMF for z/OS Grafana plugin user guide as a PDF file.
    diff --git a/docs/grafana/rmf-app/indexTerms.html b/docs/grafana/rmf-app/indexTerms.html index 43c161eb..be33a5ca 100644 --- a/docs/grafana/rmf-app/indexTerms.html +++ b/docs/grafana/rmf-app/indexTerms.html @@ -9,9 +9,9 @@ - + - + diff --git a/docs/grafana/rmf-app/install_grafana_plugin.html b/docs/grafana/rmf-app/install_grafana_plugin.html index abe35ba1..003f7237 100644 --- a/docs/grafana/rmf-app/install_grafana_plugin.html +++ b/docs/grafana/rmf-app/install_grafana_plugin.html @@ -1,13 +1,13 @@ - - Installing the RMF for z/OS plugin on Grafana + + Installing the RMF for z/OS Grafana plugin v2.0.1 or later - + - + @@ -77,7 +77,7 @@