[Home] [Help]
PACKAGE: DBSNMP.BSLN
Source
1 package bsln
2 as
3 ----------------------------------------------------------------------------
4 --
5 -- package subtypes
6 --
7 ----------------------------------------------------------------------------
8
9 subtype guid_t is bsln_baselines.bsln_guid%TYPE;
10 subtype timegroup_field_t is bsln_timegroups.intraday%TYPE;
11 subtype timegroup_t is bsln_statistics.timegroup%TYPE;
12 subtype timegrouping_t is bsln_statistics.timegrouping%TYPE;
13 subtype fail_action_t is bsln_threshold_params.fail_action%TYPE;
14 subtype threshold_method_t is bsln_threshold_params.threshold_method%TYPE;
15 subtype param_value_t is bsln_threshold_params.critical_param%TYPE;
16 subtype preferred_status_t is bsln_metric_defaults.status%TYPE;
17
18 ----------------------------------------------------------------------------
19 --
20 -- externally visible constants and subtypes
21 --
22 ----------------------------------------------------------------------------
23
24 K_TIMEGROUPING_FIELD_X constant varchar2(1) := 'X';
25 K_TIMEGROUPING_FIELD_N constant varchar2(1) := 'N';
26 K_TIMEGROUPING_FIELD_H constant varchar2(1) := 'H';
27 K_TIMEGROUPING_FIELD_W constant varchar2(1) := 'W';
28 K_TIMEGROUPING_FIELD_D constant varchar2(1) := 'D';
29
30 K_TIMEGROUPING_XX constant timegrouping_t :=
31 K_TIMEGROUPING_FIELD_X||K_TIMEGROUPING_FIELD_X;
32 K_TIMEGROUPING_HX constant timegrouping_t :=
33 K_TIMEGROUPING_FIELD_H||K_TIMEGROUPING_FIELD_X;
34 K_TIMEGROUPING_XD constant timegrouping_t :=
35 K_TIMEGROUPING_FIELD_X||K_TIMEGROUPING_FIELD_D;
36 K_TIMEGROUPING_HD constant timegrouping_t :=
37 K_TIMEGROUPING_FIELD_H||K_TIMEGROUPING_FIELD_D;
38 K_TIMEGROUPING_XW constant timegrouping_t :=
39 K_TIMEGROUPING_FIELD_X||K_TIMEGROUPING_FIELD_W;
40 K_TIMEGROUPING_HW constant timegrouping_t :=
41 K_TIMEGROUPING_FIELD_H||K_TIMEGROUPING_FIELD_W;
42 K_TIMEGROUPING_NW constant timegrouping_t :=
43 K_TIMEGROUPING_FIELD_N||K_TIMEGROUPING_FIELD_W;
44 K_TIMEGROUPING_ND constant timegrouping_t :=
45 K_TIMEGROUPING_FIELD_N||K_TIMEGROUPING_FIELD_D;
46 K_TIMEGROUPING_NX constant timegrouping_t :=
47 K_TIMEGROUPING_FIELD_N||K_TIMEGROUPING_FIELD_X;
48
49 K_TIMEGROUP_FIELD_XX constant timegroup_field_t := 'XX';
50 K_TIMEGROUP_FIELD_DY constant timegroup_field_t := 'DY';
51 K_TIMEGROUP_FIELD_NT constant timegroup_field_t := 'NT';
52 K_TIMEGROUP_FIELD_WD constant timegroup_field_t := 'WD';
53 K_TIMEGROUP_FIELD_WE constant timegroup_field_t := 'WE';
54
55 K_DEFAULT_NUM_OCCURS constant number := 2;
56
57 K_FAIL_ACTION_UNSET constant fail_action_t := 'UNSET';
58 K_FAIL_ACTION_PRESERVE constant fail_action_t := 'PRESERVE';
59
60 K_METHOD_SIGLVL constant threshold_method_t := 'SIGLVL';
61 K_METHOD_PCTMAX constant threshold_method_t := 'PCTMAX';
62
63 K_SIGLVL_95 constant param_value_t := 0.95;
64 K_SIGLVL_99 constant param_value_t := 0.99;
65 K_SIGLVL_999 constant param_value_t := 0.999;
66 K_SIGLVL_9999 constant param_value_t := 0.9999;
67
68 K_TRUE constant integer := 1;
69 K_FALSE constant integer := 0;
70 K_YES constant varchar2(1) := 'Y';
71 K_NO constant varchar2(1) := 'N';
72
73 K_STATUS_ACTIVE constant bsln_baselines.status%TYPE := 'ACTIVE';
74 K_STATUS_INACTIVE constant bsln_baselines.status%TYPE := 'INACTIVE';
75
76 K_STATUS_PREFERRED constant preferred_status_t := 'PREFERRED';
77 K_STATUS_NONPREFERRED constant preferred_status_t := 'NONPREFERRED';
78
79 K_CATEGORY_PERFORMANCE constant bsln_metric_defaults.category%TYPE :=
80 'PERFORMANCE';
81 K_CATEGORY_DEMAND constant bsln_metric_defaults.category%TYPE :=
82 'DEMAND';
83 K_CATEGORY_SHAPE constant bsln_metric_defaults.category%TYPE :=
84 'SHAPE';
85
86 K_SCORE_MAXIMUM constant number := 10.0;
87 K_SCORE_HIGHINC constant number := 5.0;
88 K_SCORE_MEDIUMEXC constant number := 0.0;
89
90 ----------------------------------------------------------------------------
91 --
92 -- package exception declarations
93 --
94 ----------------------------------------------------------------------------
95
96 X_INVALID_BASELINE constant number := -20101;
97 X_INVALID_INTERVAL constant number := -20102;
98 -- X_DATASOURCE_NOT_FOUND constant number := -20103; -- DEPRECATED
99 X_INVALID_THRESHOLD_METHOD constant number := -20104;
100 X_INVALID_METRIC constant number := -20105;
101 X_BASELINE_NOT_FOUND constant number := -20106;
102 -- X_SOURCE_CONFLICT constant number := -20107; -- DEPRECATED
103 X_NOT_SUPPORTED constant number := -20108;
104 X_BSLNTHR_ERROR constant number := -20109;
105 X_DEPRECATION_ERROR constant number := -20110;
106 X_INVALID_TIMEGROUPING constant number := -20111;
107
108 INVALID_BASELINE exception;
109 INVALID_INTERVAL exception;
110 -- DATASOURCE_NOT_FOUND exception; -- DEPRECATED
111 INVALID_THRESHOLD_METHOD exception;
112 INVALID_METRIC exception;
113 BASELINE_NOT_FOUND exception;
114 -- SOURCE_CONFLICT exception; -- DEPRECATED
115 NOT_SUPPORTED exception;
116 BSLNTHR_ERROR exception;
117 DEPRECATION_ERROR exception;
118 INVALID_TIMEGROUPING exception;
119
120 PRAGMA EXCEPTION_INIT(INVALID_BASELINE, -20101);
121 PRAGMA EXCEPTION_INIT(INVALID_INTERVAL, -20102);
122 -- PRAGMA EXCEPTION_INIT(DATASOURCE_NOT_FOUND, -20103); -- DEPRECATED
123 PRAGMA EXCEPTION_INIT(INVALID_THRESHOLD_METHOD, -20104);
124 PRAGMA EXCEPTION_INIT(INVALID_METRIC, -20105);
125 PRAGMA EXCEPTION_INIT(BASELINE_NOT_FOUND, -20106);
126 -- PRAGMA EXCEPTION_INIT(SOURCE_CONFLICT, -20107); -- DEPRECATED
127 PRAGMA EXCEPTION_INIT(NOT_SUPPORTED, -20108);
128 PRAGMA EXCEPTION_INIT(BSLNTHR_ERROR, -20109);
129 PRAGMA EXCEPTION_INIT(DEPRECATION_ERROR, -20110);
130 PRAGMA EXCEPTION_INIT(INVALID_TIMEGROUPING, -20111);
131
132 ----------------------------------------------------------------------------
133 --
134 -- utility routines
135 --
136 ----------------------------------------------------------------------------
137
138 function target_uid(dbid_in in number
139 ,instance_num_in in number)
140 return guid_t;
141
142 function this_target_uid
143 return guid_t;
144
145 function target_uid(dbid_in in number
146 ,instance_name_in in varchar2)
147 return guid_t
148 DETERMINISTIC;
149
150 function metric_uid(metric_id_in in number)
151 return guid_t
152 DETERMINISTIC;
153
154 function datasource_guid(target_uid_in in guid_t -- DEPRECATED
155 ,metric_uid_in in guid_t -- DEPRECATED
156 ,key_value_in in varchar2 := ' ') -- DEPRECATED
157 return guid_t -- DEPRECATED
158 DETERMINISTIC; -- DEPRECATED
159
160 function baseline_guid
161 (baseline_id_in in number
162 ,instance_name_in in varchar2 := NULL
163 ,dbid_in in number := NULL)
164 return guid_t;
165
166 function moving_window_baseline_guid
167 (instance_name_in in varchar2 := NULL
168 ,dbid_in in number := NULL)
169 return guid_t;
170
171 function timegroup(timegrouping_in in timegrouping_t
172 ,time_in in date)
173 return timegroup_t;
174
175 function subinterval_code(subinterval_key_in in timegrouping_t -- DEPRECATED
176 ,time_in in date) -- DEPRECATED
177 return timegroup_t; -- DEPRECATED
178
179 function timegroup(timegrouping_in in timegrouping_t
180 ,hour_of_week_in in binary_integer)
181 return timegroup_t;
182
183 ----------------------------------------------------------------------------
184 --
185 -- administration routines
186 --
187 ----------------------------------------------------------------------------
188
189 procedure update_moving_window -- DEPRECATED
190 (interval_days_in in number -- DEPRECATED
191 ,subinterval_key_in in timegrouping_t -- DEPRECATED
192 ,target_uid_in in guid_t := NULL); -- DEPRECATED
193
194 procedure create_baseline_static -- DEPRECATED
195 (name_in in varchar2 -- DEPRECATED
196 ,interval_begin_in in date -- DEPRECATED
197 ,interval_end_in in date -- DEPRECATED
198 ,subinterval_key_in in timegrouping_t -- DEPRECATED
199 ,target_uid_in in guid_t := NULL); -- DEPRECATED
200
201 procedure drop_baseline -- DEPRECATED
202 (name_in in varchar2 -- DEPRECATED
203 ,target_uid_in in guid_t := NULL); -- DEPRECATED
204
205 procedure register_datasource -- DEPRECATED
206 (dbid_in in number -- DEPRECATED
207 ,instance_num_in in number -- DEPRECATED
208 ,metric_id_in in number); -- DEPRECATED
209
210 procedure deregister_datasource -- DEPRECATED
211 (dbid_in in number -- DEPRECATED
212 ,instance_num_in in number -- DEPRECATED
213 ,metric_id_in in number); -- DEPRECATED
214
215 procedure set_default_timegrouping
216 (timegrouping_in in timegrouping_t
217 ,instance_name_in in varchar2 := NULL
218 ,dbid_in in number := NULL);
219
220 procedure activate_baseline -- DEPRECATED
221 (name_in in varchar2 -- DEPRECATED
222 ,target_uid_in in guid_t := NULL); -- DEPRECATED
223
224 procedure deactivate_baseline -- DEPRECATED
225 (name_in in varchar2 -- DEPRECATED
226 ,target_uid_in in guid_t := NULL); -- DEPRECATED
227
228 procedure set_threshold_parameters
229 (bsln_guid_in in guid_t
230 ,metric_id_in in number
231 ,threshold_method_in in threshold_method_t
232 ,warning_param_in in param_value_t
233 ,critical_param_in in param_value_t
234 ,num_occurs_in in integer := K_DEFAULT_NUM_OCCURS
235 ,fail_action_in in fail_action_t := K_FAIL_ACTION_UNSET);
236
237 procedure set_threshold_parameters -- DEPRECATED
238 (bsln_guid_in in guid_t -- DEPRECATED
239 ,ds_guid_in in guid_t -- DEPRECATED
240 ,threshold_method_in in threshold_method_t -- DEPRECATED
241 ,warning_param_in in param_value_t -- DEPRECATED
242 ,critical_param_in in param_value_t -- DEPRECATED
243 ,num_occurs_in in integer := K_DEFAULT_NUM_OCCURS -- DEPRECATED
244 ,fail_action_in in fail_action_t := K_FAIL_ACTION_UNSET);-- DEPRECATED
245
246 procedure unset_threshold_parameters
247 (bsln_guid_in in guid_t
248 ,metric_id_in in number);
249
250 ----------------------------------------------------------------------------
251 -- enable/disable API, deprecated in 11.1
252 ----------------------------------------------------------------------------
253 procedure enable; -- DEPRECATED
254 procedure disable; -- DEPRECATED
255 function is_enabled return integer; -- DEPRECATED
256
257 procedure delete_bsln_jobs; -- DEPRECATED
258
259 -----------------------------------------------------------------------------
260 --
261 -- operational routines
262 --
263 -----------------------------------------------------------------------------
264
265 -----------------------------------------------------------------------------
266 -- automation hooks, deprecated in 11.1
267 -----------------------------------------------------------------------------
268 procedure set_all_thresholds; -- DEPRECATED
269 procedure compute_all_statistics; -- DEPRECATED
270
271 -----------------------------------------------------------------------------
272 -- statistics computation and quality (of extrapolation)
273 -----------------------------------------------------------------------------
274 function compute_statistics -- DEPRECATED
275 (bsln_name_in in varchar2 -- DEPRECATED
276 ,interval_begin_in in date -- DEPRECATED
277 ,interval_end_in in date -- DEPRECATED
278 ,subinterval_key_in in timegrouping_t -- DEPRECATED
279 ,target_uid_in in guid_t := NULL) -- DEPRECATED
280 return bsln_statistics_set; -- DEPRECATED
281
282 function data_and_model_OK
283 (threshold_method_in in threshold_method_t
284 ,threshold_param_in in param_value_t
285 ,sample_count_in in number
286 ,fit_quality_in in number)
287 return integer;
288
289 ----------------------------------------------------------------------------
290 -- metric quality as signal
291 ----------------------------------------------------------------------------
292
293 type signal_rectype is record
294 (bsln_guid guid_t
298 type signal_cvtype is ref cursor return signal_rectype;
295 ,metric_id number
296 ,quality number);
297
299
300 function metric_signal_qualities
301 (bsln_guid_in in guid_t
302 ,metric_ids_in in bsln_metric_set := NULL
303 ,reference_time_in in date)
304 return signal_cvtype;
305
306 ----------------------------------------------------------------------------
307 --
308 -- SLPA declarations for Design by Contract support
309 --
310 ----------------------------------------------------------------------------
311 ASSERTFAIL EXCEPTION;
312 ASSERTFAIL_C CONSTANT INTEGER := -20999;
313 PRAGMA EXCEPTION_INIT(ASSERTFAIL, -20999);
314 PKGNAME_C CONSTANT VARCHAR2(20) := 'BSLN';
315 ----------------------------------------------------------------------------
316 end bsln;