-
Notifications
You must be signed in to change notification settings - Fork 0
/
federation.html
168 lines (154 loc) · 10.5 KB
/
federation.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
<!DOCTYPE html>
<!--
| Generated by Apache Maven Doxia Site Renderer 1.7.4 at 11 Mar 2017
| Rendered using Apache Maven Fluido Skin 1.6
-->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="Date-Revision-yyyymmdd" content="20170311" />
<meta http-equiv="Content-Language" content="en" />
<title>Fine Grained Service Monitoring System – Federation targets</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.6.min.css" />
<link rel="stylesheet" href="./css/site.css" />
<link rel="stylesheet" href="./css/print.css" media="print" />
<script type="text/javascript" src="./js/apache-maven-fluido-1.6.min.js"></script>
</head>
<body class="topBarDisabled">
<a href="https://github.com/mil-oss/fgsms">
<img style="position: absolute; top: 0; right: 0; border: 0; z-index: 10000;"
src="https://s3.amazonaws.com/github/ribbons/forkme_right_green_007200.png"
alt="Fork me on GitHub">
</a>
<div class="container-fluid">
<div id="banner">
<div class="pull-left"><a href="http://mil-oss.org/" id="bannerLeft"><img src="images/mil-oss-logo.png" alt="Fine Grained Service Monitoring System"/></a></div>
<div class="pull-right"><div id="bannerRight"><img src="images/fgsms_logo_small.png" /></div>
</div>
<div class="clear"><hr/></div>
</div>
<div id="breadcrumbs">
<ul class="breadcrumb">
<li id="projectVersion">Version: 7.0.0<span class="divider">|</span></li>
<li class=""><a href="https://www.mil-oss.org" class="externalLink" title="MIL-OSS">MIL-OSS</a><span class="divider">/</span></li>
<li class="active ">Federation targets</li>
<li id="publishDate" class="pull-right">Last Published: 11 Mar 2017</li>
</ul>
</div>
<div class="row-fluid">
<div id="leftColumn" class="span2">
<div class="well sidebar-nav">
<ul class="nav nav-list">
<li><a href="index.html" title="Project Information"><span class="none"></span>Project Information</a> </li>
<li><a href="index2.html" title="Welcome"><span class="none"></span>Welcome</a> </li>
<li><a href="whitepaper.html" title="Whitepaper"><span class="none"></span>Whitepaper</a> </li>
<li><a href="architecture.html" title="Architecture"><span class="none"></span>Architecture</a> </li>
<li><a href="quickstart.html" title="Quick Start"><span class="none"></span>Quick Start</a> </li>
<li><a href="deployment-planning.html" title="Deployment Planning"><span class="none"></span>Deployment Planning</a> </li>
<li><a href="deployserver.html" title="Deploying the Server"><span class="none"></span>Deploying the Server</a> </li>
<li><a href="agentmatrix.html" title="Agent Matrix"><span class="none"></span>Agent Matrix</a> </li>
<li><a href="deployagent.html" title="Deploying Agents"><span class="none"></span>Deploying Agents</a> </li>
<li><a href="user.html" title="User Guide"><span class="none"></span>User Guide</a> </li>
<li><a href="reporting.html" title="Reports and data access"><span class="none"></span>Reports and data access</a> </li>
<li><a href="security.html" title="Security Guide"><span class="none"></span>Security Guide</a> </li>
<li><a href="permissions.html" title="Access Control"><span class="none"></span>Access Control</a> </li>
<li class="active"><a href="#"><span class="none"></span>Data Federation</a>
</li>
<li><a href="news.html" title="News"><span class="none"></span>News</a> </li>
<li><a href="sdk.html" title="SDK"><span class="none"></span>SDK</a> </li>
<li><a href="specs.html" title="Specs/ICD"><span class="none"></span>Specs/ICD</a> </li>
<li><a href="committer.html" title="Committers"><span class="none"></span>Committers</a> </li>
<li><a href="faq.html" title="FAQ"><span class="none"></span>FAQ</a> </li>
<li class="nav-header">Modules</li>
<li><a href="apache-tomcat/index.html" title="Pre-Configured Apache Tomcat"><span class="none"></span>Pre-Configured Apache Tomcat</a> </li>
<li><a href="apache-juddi/index.html" title="Pre-Configured Apache Juddi"><span class="none"></span>Pre-Configured Apache Juddi</a> </li>
<li><a href="fgsms-common-interfaces/index.html" title="fgsms Interfaces WS Stubs and Schema Bindings Generated from WSDL"><span class="none"></span>fgsms Interfaces WS Stubs and Schema Bindings Generated from WSDL</a> </li>
<li><a href="fgsms-common/index.html" title="fgsms Common"><span class="none"></span>fgsms Common</a> </li>
<li><a href="fgsms-agents/index.html" title="fgsms Embedded Agents"><span class="none"></span>fgsms Embedded Agents</a> </li>
<li><a href="fgsms-ws-notification/index.html" title="fgsms WS-Notification Parent"><span class="none"></span>fgsms WS-Notification Parent</a> </li>
<li><a href="fgsms-server/index.html" title="fgsms Server"><span class="none"></span>fgsms Server</a> </li>
<li><a href="fgsms-cli/index.html" title="fgsms Command Line Interface"><span class="none"></span>fgsms Command Line Interface</a> </li>
<li><a href="fgsms-samples/index.html" title="fgsms Examples Packages"><span class="none"></span>fgsms Examples Packages</a> </li>
<li><a href="fgsms-dist/index.html" title="fgsms Distribution"><span class="none"></span>fgsms Distribution</a> </li>
<li><a href="fgsms-netagent/index.html" title="fgsms.Net Components"><span class="none"></span>fgsms.Net Components</a> </li>
<li class="nav-header">Project Documentation</li>
<li><a href="project-info.html" title="Project Information"><span class="icon-chevron-right"></span>Project Information</a> </li>
<li><a href="project-reports.html" title="Project Reports"><span class="icon-chevron-right"></span>Project Reports</a> </li>
</ul>
<form id="search-form" action="https://www.google.com/search" method="get" >
<input value="https://mil-oss.github.io/" name="sitesearch" type="hidden"/>
<input class="search-query" name="q" id="query" type="text" />
</form>
<script type="text/javascript">asyncJs( 'https://cse.google.com/brand?form=search-form' )</script>
<hr />
<div id="poweredBy">
<div class="clear"></div>
<div class="clear"></div>
<div class="clear"></div>
<div class="clear"></div>
<a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"><img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /></a>
</div>
</div>
</div>
<div id="bodyColumn" class="span10" >
<h1>Federation targets</h1>
<p>On a per service basis, FGSMS supports the ability to add a <tt>Federation Target</tt> to a service policy. A <tt>federation target</tt> is simply a pluggable interface for periodically publishing metrics (that you choose) on a service.</p>
<div class="section">
<h2><a name="Whats_out_of_the_box"></a>What’s out of the box?</h2>
<p>As of right now, only the available component is the UDDI publisher.</p></div>
<div class="section">
<h2><a name="How_often_does_it_publish"></a>How often does it publish?</h2>
<p>The publication frequency is administrator defined via <tt>General Settings</tt>. The default is every 5 minutes. </p>
<div class="section">
<h3><a name="The_UDDI_Publisher"></a>The UDDI Publisher</h3>
<p>FGSMS provides a <a class="externalLink" href="http://uddi.org/pubs/uddi_v3.htm">Universal Description Discovery & Integration</a> publisher. When the publish job fires, it will modify the content of an already published <a class="externalLink" href="http://www.uddi.org/pubs/uddi_v3.htm#_Toc85908020">UDDI Binding Template</a> by appending <a class="externalLink" href="http://www.uddi.org/pubs/uddi_v3.htm#_Toc515847044">tModel Instance Infos</a> that represent the metrics over the selected period of time.</p></div>
<div class="section">
<h3><a name="What_can_it_publish"></a>What can it publish?</h3>
<p>The following can be published on a per service basis for user selected time periods:</p>
<ul>
<li>Average response time, request size, response size</li>
<li>Maximum response time, request size, response size</li>
<li>Successful transactions</li>
<li>Failing transactions</li>
<li>MTBF</li>
<li>SLA violations</li>
<li>Availability - % of the time a service was available</li>
</ul>
<p>In addition, status information can also be published.</p>
<ul>
<li>Status - Publishes last known status and the time stamp.</li>
<li>Last time stamp the status changed.</li>
</ul>
<p><a href="images/uddi-federatiion-publish.png" target="_blank">Apache jUDDI screen shot with FGSMS data</a></p>
<h1>SDK stufff</h1>
<p>Below the section is all about how to make your own federation plugin. If you’re not a developer, your time is better spent else where</p></div></div>
<div class="section">
<h2><a name="How_to_make_a_custom_Federation_Target"></a>How to make a custom Federation Target</h2>
<p>First off, make a new Java project in your IDE of choice and reference the following maven artifact:</p>
<div class="source">
<div class="source"><pre class="prettyprint linenums">groupId `org.mil-oss`
artifactId `fgsms-common-interfaces`
</pre></div></div>
<div class="section">
<h3><a name="Implementing_the_interface"></a>Implementing the interface</h3>
<p>Make a class and have it implement <tt>org.miloss.fgsms.plugins.federation.FederationInterface</tt> The rest is filling in the blanks.</p></div>
<div class="section">
<h3><a name="Configuration_settings"></a>Configuration settings</h3>
<p>There’s a few ways to provide configuration options to your plugin. If you want only administrator defined settings that apply to everything, you’ll want to check out the <tt>DBSettingsLoader</tt> class.</p>
<p>If you want users/operators to be able to have service specific settings, then make sure you override <tt>GetRequiredParameters</tt>, <tt>GetOptionalParameters</tt>, and <tt>ValidateConfiguration</tt> which helps guide users towards a successful configuration. </p></div>
<div class="section">
<h3><a name="Deploying_and_Registering_your_plugin"></a>Deploying and Registering your plugin</h3>
<p>See the <a href="sdk.html">SDK</a> guide for deploying SLA agents for the guide.</p></div></div>
</div>
</div>
</div>
<hr/>
<footer>
<div class="container-fluid">
<div class="row-fluid">
</div>
</div>
</footer>
</body>
</html>