Build beautiful and interactive API documentation for ORDS

Image
In this blog post, I will show you how to quickly build beautiful and interactive API documentation for your Oracle APEX REST data sources using  swagger hub . Using APEX v23.1. I downloaded the  titanic data set  and loaded them into tables in my APEX instance, created some authorized restful services and published them using swagger hub. You can create a free account on swagger hub.   Check out my titanic swagger hub here ; Press Authorize. Username REST, password Glasgow123! I won't go through creating RESTful services and just show you the four I created that sit on top of the titanic data set; The GET is a very simple SQL query;      select * from TITANIC_DATA_SET_NEW A handy tip is to add comments, as there will appear on swagger hub, making your API self documenting; Once you have created your modules, press the Generate Swagger Doc button; This will generate an open API for you.  Copy the API and paste it into swagger hub This will generat...
Post a Comment

Test & Monitor you APEX app. Part 3 : Monitor your DB with JMeter and Jenkins

This is the third of a series of posts where I will show you how you can use free open source software Jenkins and JMeter  to monitor your APEX database.

Part 1 - Monitor your APEX app using Jenkins

Part 2 - Monitor your APEX app using Google Analytics

In the next post, I will show you how you can run scheduled Selenium tests on your APEX app, the tests will log into your app and run Selenium tests which will be hosted on a free GitHub account using GitHub actions so no installation of any software necessary. You will have your APEX application scheduled selenium tests (getting email alerts if any issues with your APEX application) up in running in minutes by cloning a ready-made GitHub APEX selenium repo.

Prerequisite: Install JMeter on the same server as Jenkins.  Like Jenkins, JMeter is simple to set up and there are lots of online guides, so I won't go into it here.

First we are going to set up the DB monitoring job on JMeter then schedule it from Jenkins.

Run JMeter in GUI mode

Add a thread group


Add a JDBC Connection configuration to connect to your APEX DB;


give it the name oracle_db, (we are going to use this in the JDBC request) and enter your database connection details;


now we add the JDBC request, in this case I want to ensure that a table has been updated in the last 24 hours and if it hasn't, I want alerted by email;

select
CASE
        WHEN max(w_update_dt) < sysdate-1
        THEN
          'WARNING Reload older then 1 day'
        ELSE
           'OK'
      END status
from PDRL2.eprint_pdr_publications 

now add the actual JDBC request;

this is where we are going to add the SQL, put in oracle_db as the connection config name;

Now we add the check to ensure the data is not stale by adding a BeanShell Assertion;


Note we are referencing dataFromDb which was set up in the JDBC Request.  The code is;


log.info("Response is  " + vars.getObject("dataFromDB").get(0).get("STATUS"));

if (prev.getResponseMessage() != "OK" || 
!vars.getObject("dataFromDB").get(0).get("STATUS").equalsIgnoreCase( "OK"))
{
      SampleResult.setSuccessful(false);
      IsSuccess=false;
      SampleResult.setStopTestNow(true);
}

The whole job looks like this


The view results tree, summary report etc are for viewing the results.  Try it out by pressing the green button;


View the results in the View results tree.  If everything is OK, we are ready to set up Jenkins to schedule it;

I am saving it as Oracle_ensure_publication_data_recent.jmx which we are going to call from Jenkins. I also created a directory Oracle_ensure_publication_data_recent which is where the results are stored.

In Jenkins, create a new freestyle item (same as setting up item in part 1) and configure how often it will run;

Build is where we call the JMeter job, as both Jenkins and JMeter are installed on the same server we reference the JMeter job like this;


C:\apps\apache-jmeter-5.2.1\bin\jmeter -n -t C:\apps\apache-jmeter-5.2.1\bin\oracle_db_ensure_publication_data_recent.jmx -f -l C:\apps\apache-jmeter-5.2.1\bin\oracle_db_ensure_publication_data_recent.jtl -e -o C:\apps\apache-jmeter-5.2.1\bin\oracle_db_ensure_publication_data_recent_output


Set the error threshold;

list the emails any alerts will be sent to;

Your APEX database is now monitored.  Once you have set up one job its easy to set up subsequent jobs by following the same principles.  I have several jobs monitoring our APEX DB, sending alerts if it identifies any problems.

Tip

When creating another JMeter schedule in Jenkins, type in your existing JMeter job and just change the JMeter script in the build.

  







Comments

Post a Comment

Popular posts from this blog

Oracle APEX Interactive Grid colour cells based on a condition using JavaScript and CSS

Image
In this post I will describe how to colour an Interactive Grid based on a column condition using CSS and JavaScript.  Using APEX Version 19.2. I want to colour every column red in my IG when the value is 'No'.   I have several IGs on my page I want to colour, so I set all my IGs that I want to colour with a CSS class of ATTENDEE_SCORE_IG in the Appearance section of the IG; Every column I want to colour in the IG I set the CSS Class to COLOUR_YES_NO (in this example I set this in 5 columns); I then created a Dynamic Action (DA) that contains the JavaScript that has the condition check that will colour the cells.  Because I have several IGs that are details of the master/detail relationship and these are refreshed by the user clicking on the master detail IG I have made my DA a Page Change [Interactive Grid].  If you don't need this you can set the DA on page load. The JS which will colour every column is this; ////////////////////////////////////////////////////...
Read more

Oracle APEX style an Interactive Grid cell conditionally based on the value of another cell using JavaScript and CSS

Image
This blog post describes how you can style an Interactive Grid cell conditionally based on the value of another cell using JQuery and CSS.  Using APEX Version 19.2. The requirement is to highlight the cell that has the highest value in the row; This can be achieved by setting the IG column CSS class and using JQuery to loop round the table rows to conditionally set CSS style based on cell values First give all your columns a CSS Class (note you can give columns multiple classes separated with space) in this case all 4 columns are set with CSS class SCORE_C_1, SCORE_C_2, SCORE_C3 and SCORE_C_4 in the column Appearance; We now add the JavaScript in Execute when page loads (preferably put this is a JS file). We are using the JQuery $.each() method to fetch every table row;  $.each($('tbody tr'), function(i, item) {} and the JQuery text() method to get the column value from the row using the column CSS class names;         var scoreC1 = $(item).find('.SCOR...
Read more

Add a timeline diagram chart to your APEX app - Part 2 of the HighChart Series

Image
How to add a timeline diagram chart to your APEX app using HighCharts and JQuery.  This is the second in the series of blog posts showing you how to add HighCharts to your APEX application. Demo I have been using HighCharts in my web apps for a number of years and in my opinion its the best charting JavaScript library out there, its free to use for non-commercial use, robust, well documented, mobile friendly and a great addition to your APEX app.   I work for the University of Glasgow and the next project I am starting is an APEX project where staff members apply for academic promotion. There are many stages to the application process, manager approval, board of review, college review, etc.  A timeline diagram displaying the process to the users will be ideal.  This is how I will do it. As an aside, for American readers  this   is a fascinating story I have recently learned about the University.  James McCune Smith born a slave and the first Afric...
Read more