{"id":1050,"date":"2020-08-19T06:31:32","date_gmt":"2020-08-19T06:31:32","guid":{"rendered":"http:\/\/spiderwiz.org\/project\/?page_id=1050"},"modified":"2025-04-09T06:15:58","modified_gmt":"2025-04-09T06:15:58","slug":"lesson-14","status":"publish","type":"page","link":"https:\/\/spiderwiz.org\/project\/tutorial\/lesson-14\/","title":{"rendered":"Lesson 14: Monitor, Manage, Maintain and Control Your Applications with SpiderAdmin"},"content":{"rendered":"\n

The SpiderAdmin<\/a> service was introduced in Lesson 3<\/a>.\nWe will now go thoroughly through its features and benefits. For the sake of\ncompleteness we repeat the introduction that was presented there.<\/p>\n\n\n\n

If\nyou want your application to participate in the game then the first thing you\nhave to do is to include the SpiderAdmin dependency in your project.\nSpiderAdmin is a complimentary service that is not available on the Maven Central Repository<\/a>, therefore you need to define the Spiderwiz internal\nrepository in your project:<\/p>\n\n\n\n

<project>\n  ...\n  <repositories>\n    <repository>\n      <id>spiderwiz-internal<\/id>\n      <url>http:\/\/spiderwiz.org\/repo<\/url>\n    <\/repository>\n  <\/repositories>\n  ...\n<\/project><\/pre><\/div>\n\n\n\n
With\nthis in place you can specify the spider-admin<\/code>\ndependency:<\/p>\n\n\n\n
<dependency>\n    <groupId>org.spiderwiz<\/groupId>\n    <artifactId>spiderwiz-admin<\/artifactId>\n    <version>2.2<\/version>\n<\/dependency><\/pre><\/div>\n\n\n\n
Non-Maven\nusers can download spiderwiz-admin.jar<\/code>\ndirectly by this link<\/a>.<\/p>\n\n\n\n
As\nmentioned above, this needs to be included in every<\/strong> application that you want to be governed by SpiderAdmin.\nHowever, it is enough to connect only\none<\/strong> application to the service, and it will be used as a \u201chole\u201d through\nwhich the \u201ccolonoscope\u201d penetrates the entire service-mesh and administers\nevery SpiderAdmin-enabled application. The demonstration hereinafter\nassumes that the \u201chole\u201d\nis My Hub<\/em>. It works as follows:<\/p>\n\n\n\n
First,\nyou must be a registered SpiderAdmin user. Go here<\/a> and use the panel on the right of the screen to register, or log\nin if you have done it already. If you prefer not to register at this moment\nbut still want to taste the experience, you can use the predefined \u201ctest\u201d user\nwith \u201ctest\u201d also as the password. Once logged in, you will be redirected to the\nSpiderAdmin service page. If you have not connected yet any application to the\nservice (and if you use the \u201ctest\u201d account then no other user of that account\nhas), you will see a page like this:<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
Follow\nthe instructions on the page and copy the displayed configuration property to hub.conf<\/code>, which will now look like this:<\/p>\n\n\n\n
[log folder]Logs\n[consumer server-1]websocket;ping-rate=30\n[producer server-1]websocket;ping-rate=30\n[consumer server-2]port=10001\n[spideradmin]W6WEMWZEbCRImAMvgf2M2Xtt3tvH\n[hub mode]yes\n[mail system]smtp;server=smtp.gmail.com;user=tester@spiderwiz.org;pwd=dumptrump;port=465;ssl=true\n[from address]My Hub Alerts<alert@spiderwiz.org>\n[to email]Spiderwiz Administrator<spiderwiz.admin@gmail.com>\n[to exception email]Spiderwiz Programmer<spiderwiz.geek@gmail.com><\/pre><\/div>\n\n\n\n
Restart\nMy Hub<\/em> and all the other\napplications. Soon the SpiderAdmin service page will refresh to show something\nlike this:<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
Let’s\ndwell on what we see here. The \u201cApplications\u201d table shows all the active\napplications, while the \u201cProducers\u201d table shows My Hub<\/em> that connects directly. You can now surf through the entire\nservice mesh by clicking from application to application.<\/p>\n\n\n\n
We\nremind you that the only application that connects to the service directly is My Hub<\/em>. It means that the other\napplications do not need to do it, and actually they do not even need to have\nInternet access. In terms of cloud computing, your application network can span across\ndifferent clouds with different protection attributes. The only requirements\nare that they will be connected somehow, the connection will be configured by\nSpiderwiz and at least one of them will be configured to connect to\nSpiderAdmin.<\/p>\n\n\n\n
Note that SpiderAdmin is not a\nfull-fledged management system such as Istio<\/a>, for instance. It\ndoes not deal with security, resource control, short circuits and some other\ncommonly available management features. On the other hand, unlike common\nmanagement systems that require full access to the managed applications,\nSpiderAdmin can monitor, configure, download log files, control and even\nupgrade applications that are behind a firewall.<\/p>\n\n\n\n
Another unique aspect of\nSpiderAdmin is that it controls and monitors the logical<\/strong> data paths between applications. With SpiderAdmin you can\nsee not only how<\/strong> data moves between\napplications, but also what<\/strong> moves\nbetween them. And you can customize SpiderAdmin<\/a>\nto expose any information that you need about the execution of your\napplications. In other words, if common management systems are supposed to\nensure that your applications are deployed and function the way you want them\nto, SpiderAdmin helps you to ensure that they do what you expect them to do.\nSpiderAdmin and management systems can peacefully exist side by side with quite\na small overlap between them.<\/p>\n\n\n\n
Having clarified that point, let\u2019s\ndelve into various SpiderAdmin features.<\/p>\n\n\n\n
As you can see in the screenshot\nabove, SpiderAdmin displays information about the networked applications, their\nstatus and the traffic between them. With the respect to the latter, Spiderwiz\nshows statistics of both physical traffic (in the \u201cCompressed input\u201d column) \u2013\ncounting the actual number of bytes on the line, and logical traffic (in the\n\u201cUncompressed input\u201d column) \u2013 measuring the volume of the full data that the\nphysical bytes represent.<\/p>\n\n\n\n
Every application name is a link\nto the application page. Try clicking on \u201cChat\nRoom Bridge<\/em>\u201d and you will see something like this:<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
You see a \u201cServer information\u201d table that shows information\nabout the machine that runs the current application (Chat Room Bridge<\/em>), an \u201cApplications\u201d table that shows all the\napplications that interact with the current application, an \u201cImport channels\u201d\ntable that shows the import-export channels that are interfaced by the current\napplication and a \u201cConsumers\u201d application that shows My Hub<\/em>, which is the only application that is connected to the\ncurrent application directly, in this case as a consumer. If there were direct\nproducers you would also see a \u201cProducers\u201d table.<\/p>\n\n\n\n
Note that the applications listed in the \u201cApplications\u201d\ntable are not necessarily connected directly by the current application. They\nare there because they exchange Data Objects with the current application.\nThat’s why My Hub<\/em> is not in the\n\u201cApplications\u201d table, as it is only a hub that Data Objects go through.<\/p>\n\n\n\n
Let\u2019s start now with some action. If you click the \u201cUpdate\nConfiguration\u201d button at the top-left of the page, you should see something\nlike this:<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
You see the configuration table of the current application.\nYou can modify any property (except application\nuuid<\/em>) and click the \u2713<\/span>\nsymbol on the top-right of the pop-up window. The changes will have an\nimmediate effect. If, for instance, you change anything in producer-1<\/code> or import-1<\/code>,\nthen the referred channel is disconnected and reconnected with the new\nparameters.<\/p>\n\n\n\n
Try clicking the next button \u2013 \u201cView Logs\u201d. You get\nsomething like this:<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
You see the listing of the configured \u201clog folder\u201d. You can\nclick on subfolder names to get their listing. When you get to a listing that\nincludes log files, you can click on the file name to download it.<\/p>\n\n\n\n
If you prefer to access log files directly, you can use the\n\u201cFlush Logs\u201d button to flush all logs files before you access them. There is no\nneed to do that if you download log files through the \u201cView Logs\u201d button\nbecause this is done automatically before a file is downloaded.<\/p>\n\n\n\n
Using the \u201cMaintenance\u201d button you can restart your\napplication and even upgrade it (without having access to the machine that runs\nthe application!). To make it work you need to ensure that your application is\nconfigured properly for activating the right \u201crestart\u201d and \u201cdeploy\u201d commands,\nas follows:<\/p>\n\n\n\n