Blame - docs/sections/apis/ves.rst - onap/dcaegen2

2019-05-14 17:45:22 +0000

[diff] [blame]

2013

Lusheng Ji

2017-10-12 02:47:00 +0000

[diff] [blame]

2014

lastEpochMicrosec | Yes | number | | | the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds

2015

2016

2017

priority | Yes | string | | {'enum': ['High', 'Medium', 'Normal', 'Low']} | processing priority

startEpochMicrosec | Yes | number | | | the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds

2024

2025

2026

.. _d_6e043350cba5faafe21de49c2f6fd745:

2027

2028

counter Model Structure

2029

-----------------------

performance counter

.. csv-table::

:delim: |

:header: "Name", "Required", "Type", "Format", "Properties", "Description"

2036

:widths: 20, 10, 15, 15, 30, 25

2037

Eric Debeau

2019-05-14 17:45:22 +0000

[diff] [blame]

2038

criticality | Yes | string | | {'enum': ['CRIT', 'MAJ']} |

Lusheng Ji

2017-10-12 02:47:00 +0000

[diff] [blame]

2042

2043

.. _d_6f081937f31c09078c8acf9212d6c449:

2044

2045

cpuUsage Model Structure

2046

------------------------

2047

2048

usage of an identified CPU

.. csv-table::

:delim: |

:header: "Name", "Required", "Type", "Format", "Properties", "Description"

2053

:widths: 20, 10, 15, 15, 30, 25

.. _d_bb7a69764c21219953df76826934938e:

2067

2068

diskUsage Model Structure

2069

-------------------------

2070

2071

usage of an identified disk

.. csv-table::

:delim: |

:header: "Name", "Required", "Type", "Format", "Properties", "Description"

2076

:widths: 20, 10, 15, 15, 30, 25

2077

2078

2079

diskIoTimeAvg | No | number | | | milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the average over the measurement interval

2080

diskIoTimeLast | No | number | | | milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the last value measurement within the measurement interval

2081

diskIoTimeMax | No | number | | | milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the maximum value measurement within the measurement interval

2082

diskIoTimeMin | No | number | | | milliseconds spent doing input/output operations over 1 sec; treat this metric as a device load percentage where 1000ms matches 100% load; provide the minimum value measurement within the measurement interval

2083

diskMergedReadAvg | No | number | | | number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the average measurement within the measurement interval

2084

diskMergedReadLast | No | number | | | number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the last value measurement within the measurement interval

2085

diskMergedReadMax | No | number | | | number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the maximum value measurement within the measurement interval

2086

diskMergedReadMin | No | number | | | number of logical read operations that were merged into physical read operations, e.g., two logical reads were served by one physical disk access; provide the minimum value measurement within the measurement interval

2087

diskMergedWriteAvg | No | number | | | number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the average measurement within the measurement interval

2088

diskMergedWriteLast | No | number | | | number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the last value measurement within the measurement interval

2089

diskMergedWriteMax | No | number | | | number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the maximum value measurement within the measurement interval

2090

diskMergedWriteMin | No | number | | | number of logical write operations that were merged into physical write operations, e.g., two logical writes were served by one physical disk access; provide the minimum value measurement within the measurement interval

.. _d_c911a0a8abdb511d7cd6590f383d817b:

2121

2122

endOfCallVqmSummaries Model Structure

2123

-------------------------------------

2124

2125

provides end of call voice quality metrics

.. csv-table::

:delim: |

:header: "Name", "Required", "Type", "Format", "Properties", "Description"

2130

:widths: 20, 10, 15, 15, 30, 25

2131

2132

2133

endpointDescription | Yes | string | | {'enum': ['Caller', 'Callee']} | Either Caller or Callee

Eric Debeau

2019-05-14 17:45:22 +0000

[diff] [blame]

Lusheng Ji

2017-10-12 02:47:00 +0000

[diff] [blame]

2148

mosCqe | No | number | | | 1-5 1dp

2149

packetLossPercent | No | number | | | Calculated percentage packet loss based on Endpoint RTP packets lost (as reported in RTCP) and Local RTP packets sent. Direction is based on Endpoint description (Caller, Callee). Decimal (2 dp)

Eric Debeau

2019-05-14 17:45:22 +0000

[diff] [blame]

2150

Lusheng Ji

2017-10-12 02:47:00 +0000

[diff] [blame]

2151

rFactor | No | number | | | 0-100

2152

2153

2154

.. _d_0eeffb3cd3e31135c2f3cf8ee4a2bdbb:

2155

2156

event Model Structure

2157

---------------------

2158

2159

the root level of the common event format

.. csv-table::

:delim: |

:header: "Name", "Required", "Type", "Format", "Properties", "Description"

2164

:widths: 20, 10, 15, 15, 30, 25

2165

Eric Debeau

2019-05-14 17:45:22 +0000

[diff] [blame]

Lusheng Ji

2017-10-12 02:47:00 +0000

[diff] [blame]

2177

2178

.. _d_4089a4a9ee684770c6f37a588a577589:

2179

2180

eventDomainThrottleSpecification Model Structure

2181

------------------------------------------------

2182

2183

specification of what information to suppress within an event domain

.. csv-table::

:delim: |

:header: "Name", "Required", "Type", "Format", "Properties", "Description"

2188

:widths: 20, 10, 15, 15, 30, 25

suppressedNvPairsList | No | array of :ref:`suppressedNvPairs <d_52877eda2d273b282063857f97fa7ff4>` | | | Optional list of specific NvPairsNames to suppress within a given Name-Value Field

2193

2194

.. _d_e7aa5254472f7823fdd6d5a090bfd0a4:

2195

2196

faultFields Model Structure

2197

---------------------------

2198

2199

fields specific to fault events

.. csv-table::

:delim: |

:header: "Name", "Required", "Type", "Format", "Properties", "Description"

2204

:widths: 20, 10, 15, 15, 30, 25

eventSeverity | Yes | string | | {'enum': ['CRITICAL', 'MAJOR', 'MINOR', 'WARNING', 'NORMAL']} | event severity

2211

eventSourceType | Yes | string | | | type of event source; examples: card, host, other, port, portThreshold, router, slotThreshold, switch, virtualMachine, virtualNetworkFunction

2212

2213

2214

vfStatus | Yes | string | | {'enum': ['Active', 'Idle', 'Preparing to terminate', 'Ready to terminate', 'Requesting termination']} | virtual function status enumeration

2215

2216

.. _d_76d7f35861442236cee9f716ea1e1540:

2217

2218

featuresInUse Model Structure

2219

-----------------------------

2220

2221

number of times an identified feature was used over the measurementInterval

.. csv-table::

:delim: |

:header: "Name", "Required", "Type", "Format", "Properties", "Description"

2226

:widths: 20, 10, 15, 15, 30, 25

2227

Eric Debeau

2019-05-14 17:45:22 +0000

[diff] [blame]

2228

2229

Lusheng Ji

2017-10-12 02:47:00 +0000

[diff] [blame]

2230

2231

.. _d_a9799335edbbc52c7f0c5191f7bd09ee:

2232

2233

field Model Structure

2234

---------------------

name value pair

.. csv-table::

:delim: |

:header: "Name", "Required", "Type", "Format", "Properties", "Description"

2241

:widths: 20, 10, 15, 15, 30, 25

2242

Eric Debeau

2019-05-14 17:45:22 +0000

[diff] [blame]

2243

2244

Lusheng Ji

2017-10-12 02:47:00 +0000

[diff] [blame]

2245

2246

.. _d_18e1fa5fd6774deefce826b075f8b6e7:

2247

2248

filesystemUsage Model Structure

2249

-------------------------------

2250

Eric Debeau

2019-05-14 17:45:22 +0000

[diff] [blame]

2251

disk usage of an identified virtual machine in gigabytes and/or gigabytes per

2252

second

Lusheng Ji

2017-10-12 02:47:00 +0000

[diff] [blame]

.. csv-table::

:delim: |

:header: "Name", "Required", "Type", "Format", "Properties", "Description"

2257

:widths: 20, 10, 15, 15, 30, 25

2258

Eric Debeau

2019-05-14 17:45:22 +0000

[diff] [blame]

Lusheng Ji

2017-10-12 02:47:00 +0000

[diff] [blame]

2266

2267

.. _d_bb1527d221e848e0896c78552979238b:

2268

2269

gtpPerFlowMetrics Model Structure

2270

---------------------------------

2271

2272

Mobility GTP Protocol per flow metrics

.. csv-table::

:delim: |

:header: "Name", "Required", "Type", "Format", "Properties", "Description"

2277

:widths: 20, 10, 15, 15, 30, 25

2278

2279

2280

avgPacketDelayVariation | Yes | number | | | Average packet delay variation or jitter in milliseconds for received packets: Average difference between the packet timestamp and time received for all pairs of consecutive packets

durConnectionFailedStatus | No | number | | | duration of failed state in milliseconds, computed as the cumulative time between a failed echo request and the next following successful error request, over this reporting interval

2285

durTunnelFailedStatus | No | number | | | Duration of errored state, computed as the cumulative time between a tunnel error indicator and the next following non-errored indicator, over this reporting interval

2286

2287

flowActivationEpoch | Yes | number | | | Time the connection is activated in the flow (connection) being reported on, or transmission time of the first packet if activation time is not available

2288

2289

flowActivationTime | No | string | | | time the connection is activated in the flow being reported on, or transmission time of the first packet if activation time is not available; with RFC 2822 compliant format: Sat, 13 Mar 2010 11:29:05 -0800

flowDeactivationTime | Yes | string | | | Transmission time of the first packet in the flow connection being reported on; with RFC 2822 compliant format: Sat, 13 Mar 2010 11:29:05 -0800

ipTosCountList | No | array of array of number | | | array of key: value pairs where the keys are drawn from the IP Type-of-Service identifiers which range from '0' to '255', and the values are the count of packets that had those ToS identifiers in the flow

maxPacketDelayVariation | Yes | number | | | Maximum packet delay variation or jitter in milliseconds for received packets: Maximum of the difference between the packet timestamp and time received for all pairs of consecutive packets

2302

2303

2304

mobileQciCosCountList | No | array of array of number | | | array of key: value pairs where the keys are drawn from LTE QCI or UMTS class of service strings, and the values are the count of packets that had those strings in the flow

tcpFlagCountList | No | array of array of number | | | array of key: value pairs where the keys are drawn from TCP Flags and the values are the count of packets that had that TCP Flag in the flow

.. _d_6ea626e11ce7887cddd39c36ff4f0926:

2331

2332

heartbeatFields Model Structure

2333

-------------------------------

2334

2335

optional field block for fields specific to heartbeat events

.. csv-table::

:delim: |

:header: "Name", "Required", "Type", "Format", "Properties", "Description"

2340

:widths: 20, 10, 15, 15, 30, 25

.. _d_2873d30f54c59ef635c1fc0cbbaa89f1:

2347

2348

internalHeaderFields Model Structure

2349

------------------------------------

2350

Eric Debeau

2019-05-14 17:45:22 +0000

[diff] [blame]

2351

enrichment fields for internal VES Event Listener service use only, not

2352

supplied by event sources

Lusheng Ji

2017-10-12 02:47:00 +0000

[diff] [blame]

2353

2354

.. _d_d8868aee802ae8e2b1e7ea1c4ecc1f54:

2355

2356

jsonObject Model Structure

2357

--------------------------

2358

Eric Debeau

2019-05-14 17:45:22 +0000

[diff] [blame]

2359

json object schema, name and other meta-information along with one or more

2360

object instances

Lusheng Ji

2017-10-12 02:47:00 +0000

[diff] [blame]

.. csv-table::

:delim: |

:header: "Name", "Required", "Type", "Format", "Properties", "Description"

2365

:widths: 20, 10, 15, 15, 30, 25

2366

2367

2368

nfSubscriptionId | No | string | | | identifies an openConfig telemetry subscription on a network function, which configures the network function to send complex object data associated with the jsonObject

.. _d_7bccbee07bd3044bd0b929cb6b567c03:

2375

2376

jsonObjectInstance Model Structure

2377

----------------------------------

2378

Eric Debeau

2019-05-14 17:45:22 +0000

[diff] [blame]

2379

meta-information about an instance of a jsonObject along with the actual

2380

object instance

Lusheng Ji

2017-10-12 02:47:00 +0000

[diff] [blame]

.. csv-table::

:delim: |

:header: "Name", "Required", "Type", "Format", "Properties", "Description"

2385

:widths: 20, 10, 15, 15, 30, 25

2386

Lusheng Ji

2018-03-27 23:24:33 -0400

[diff] [blame]

2387

Lusheng Ji

2017-10-12 02:47:00 +0000

[diff] [blame]

2388

objectInstanceEpochMicrosec | No | number | | | the unix time aka epoch time associated with this objectInstance--as microseconds elapsed since 1 Jan 1970 not including leap seconds

2389

2390

Lusheng Ji

2018-03-27 23:24:33 -0400

[diff] [blame]

2391

.. _i_4cf8290bf745cd386f0a55ec865aafd5:

Lusheng Ji

2017-10-12 02:47:00 +0000

[diff] [blame]

2392

2393

**Objectinstance schema:**

2394

Lusheng Ji

2017-10-12 02:47:00 +0000

[diff] [blame]

2395

an instance conforming to the jsonObject schema

2396

Lusheng Ji

2017-10-12 02:47:00 +0000

[diff] [blame]

2397

.. _d_a217491e9c44487ec7bbd9ce3ac9dddb:

key Model Structure

-------------------

tuple which provides the name of a key along with its value and relative order

.. csv-table::

:delim: |

:header: "Name", "Required", "Type", "Format", "Properties", "Description"

2407

:widths: 20, 10, 15, 15, 30, 25

.. _d_dc21244021b6cb0e0af16166e4600d99:

2414

2415

latencyBucketMeasure Model Structure

2416

------------------------------------

2417

2418

number of counts falling within a defined latency bucket

.. csv-table::

:delim: |

:header: "Name", "Required", "Type", "Format", "Properties", "Description"

2423

:widths: 20, 10, 15, 15, 30, 25

2424

Eric Debeau

2019-05-14 17:45:22 +0000

[diff] [blame]

Lusheng Ji

2017-10-12 02:47:00 +0000

[diff] [blame]

2428

2429

.. _d_669cf98e276c9992abd27056c432bbb2:

2430

2431

measurementsForVfScalingFields Model Structure

2432

----------------------------------------------

2433

2434

measurementsForVfScaling fields

.. csv-table::

:delim: |

:header: "Name", "Required", "Type", "Format", "Properties", "Description"

2439

:widths: 20, 10, 15, 15, 30, 25

configuredEntities | No | integer | | | over the measurementInterval, peak total number of: users, subscribers, devices, adjacencies, etc., for the VM, or subscribers, devices, etc., for the VNF

filesystemUsageArray | No | array of :ref:`filesystemUsage <d_18e1fa5fd6774deefce826b075f8b6e7>` | | | filesystem usage of the VM on which the VNFC reporting the event is running

2451

latencyDistribution | No | array of :ref:`latencyBucketMeasure <d_dc21244021b6cb0e0af16166e4600d99>` | | | array of integers representing counts of requests whose latency in milliseconds falls within per-VNF configured ranges

.. _d_7a758ee807f435a8ba5568e6da6ed597:

2462

2463

memoryUsage Model Structure

2464

---------------------------

2465

2466

memory usage of an identified virtual machine

.. csv-table::

:delim: |

:header: "Name", "Required", "Type", "Format", "Properties", "Description"

2471

:widths: 20, 10, 15, 15, 30, 25

.. _d_dc18fe1d28fe3ef664c3f4ab777d8424:

2483

2484

mobileFlowFields Model Structure

2485

--------------------------------

mobileFlow fields

.. csv-table::

:delim: |

:header: "Name", "Required", "Type", "Format", "Properties", "Description"

2492

:widths: 20, 10, 15, 15, 30, 25

cid | No | string | | | cell id

Eric Debeau

2019-05-14 17:45:22 +0000

[diff] [blame]

2502

Lusheng Ji

2017-10-12 02:47:00 +0000

[diff] [blame]

lac | No | string | | | location area code

2511

mcc | No | string | | | mobile country code

2512

mnc | No | string | | | mobile network code

rac | No | string | | | routing area code

sac | No | string | | | service area code

2523

samplingAlgorithm | No | integer | | | Integer identifier for the sampling algorithm or rule being applied in calculating the flow metrics if metrics are calculated based on a sample of packets, or 0 if no sampling is applied

2524

tac | No | string | | | transport area code

.. _d_38de3331d60414da3eea18e8f7e0ecf9:

2529

2530

namedArrayOfFields Model Structure

2531

----------------------------------

2532

2533

an array of name value pairs along with a name for the array

.. csv-table::

:delim: |

:header: "Name", "Required", "Type", "Format", "Properties", "Description"

2538

:widths: 20, 10, 15, 15, 30, 25

2539

2540

Eric Debeau

2019-05-14 17:45:22 +0000

[diff] [blame]

2541

Lusheng Ji

2017-10-12 02:47:00 +0000

[diff] [blame]

2542

2543

.. _d_5a79cd7ce784d60fd832d9c7c0a24322:

2544

2545

otherFields Model Structure

2546

---------------------------

2547

Eric Debeau

2019-05-14 17:45:22 +0000

[diff] [blame]

2548

fields for events belonging to the 'other' domain of the commonEventHeader

2549

domain enumeration

Lusheng Ji

2017-10-12 02:47:00 +0000

[diff] [blame]

.. csv-table::

:delim: |

:header: "Name", "Required", "Type", "Format", "Properties", "Description"

2554

:widths: 20, 10, 15, 15, 30, 25

.. _d_6747334473cf2b305fe43b61a40656e1:

2562

2563

requestError Model Structure

2564

----------------------------

2565

2566

standard request error data structure

.. csv-table::

:delim: |

:header: "Name", "Required", "Type", "Format", "Properties", "Description"

2571

:widths: 20, 10, 15, 15, 30, 25

url | No | string | | | Hyperlink to a detailed error resource e.g., an HTML page for browser user agents

2576

2577

2578

.. _d_c3e191f0b26ddd68f927ac0c8b551c5e:

2579

2580

sipSignalingFields Model Structure

2581

----------------------------------

sip signaling fields

.. csv-table::

:delim: |

:header: "Name", "Required", "Type", "Format", "Properties", "Description"

2588

:widths: 20, 10, 15, 15, 30, 25

Eric Debeau

2019-05-14 17:45:22 +0000

[diff] [blame]

2599

Lusheng Ji

2017-10-12 02:47:00 +0000

[diff] [blame]

2600

2601

.. _d_c5450f1a263d0a2b0c64c96119f7d759:

2602

2603

stateChangeFields Model Structure

2604

---------------------------------

stateChange fields

.. csv-table::

:delim: |

:header: "Name", "Required", "Type", "Format", "Properties", "Description"

2611

:widths: 20, 10, 15, 15, 30, 25

2612

2613

2614

newState | Yes | string | | {'enum': ['inService', 'maintenance', 'outOfService']} | new state of the entity

2615

oldState | Yes | string | | {'enum': ['inService', 'maintenance', 'outOfService']} | previous state of the entity

.. _d_52877eda2d273b282063857f97fa7ff4:

2620

2621

suppressedNvPairs Model Structure

2622

---------------------------------

2623

Eric Debeau

2019-05-14 17:45:22 +0000

[diff] [blame]

2624

List of specific NvPairsNames to suppress within a given Name-Value Field

2625

for event Throttling

Lusheng Ji

2017-10-12 02:47:00 +0000

[diff] [blame]

.. csv-table::

:delim: |

:header: "Name", "Required", "Type", "Format", "Properties", "Description"

2630

:widths: 20, 10, 15, 15, 30, 25

.. _d_782271970af04a3b0e5a5da9b30996d2:

2636

2637

syslogFields Model Structure

2638

----------------------------

sysLog fields

.. csv-table::

Lusheng Ji

2018-03-27 23:24:33 -0400

[diff] [blame]

2643

:delim: |

Lusheng Ji

2017-10-12 02:47:00 +0000

[diff] [blame]

2644

:header: "Name", "Required", "Type", "Format", "Properties", "Description"

2645

:widths: 20, 10, 15, 15, 30, 25

2646

Eric Debeau

2019-05-14 17:45:22 +0000

[diff] [blame]

2647

Lusheng Ji

2018-03-27 23:24:33 -0400

[diff] [blame]

2648

2649

eventSourceType | Yes | string | | | type of event source; examples: other, router, switch, host, card, port, slotThreshold, portThreshold, virtualMachine, virtualNetworkFunction

syslogSev | No | string | | {'enum': ['Alert', 'Critical', 'Debug', 'Emergency', 'Error', 'Info', 'Notice', 'Warning']} | numerical Code for severity derived from syslogPri as remaider of syslogPri / 8

2659

2660

Lusheng Ji

2017-10-12 02:47:00 +0000

[diff] [blame]

2661

2662

.. _d_bd95ac8a5536a5bb5e6a0de7e64b9f20:

2663

2664

thresholdCrossingAlertFields Model Structure

2665

--------------------------------------------

2666

2667

fields specific to threshold crossing alert events

.. csv-table::

:delim: |

:header: "Name", "Required", "Type", "Format", "Properties", "Description"

2672

:widths: 20, 10, 15, 15, 30, 25

alertAction | Yes | string | | {'enum': ['CLEAR', 'CONT', 'SET']} | Event action

2677

2678

alertType | Yes | string | | {'enum': ['CARD-ANOMALY', 'ELEMENT-ANOMALY', 'INTERFACE-ANOMALY', 'SERVICE-ANOMALY']} | Event type

eventSeverity | Yes | string | | {'enum': ['CRITICAL', 'MAJOR', 'MINOR', 'WARNING', 'NORMAL']} | event severity or priority

.. _d_b845a2955da4c78bef3ba4d50021a240:

2692

2693

vNicPerformance Model Structure

2694

-------------------------------

2695

Eric Debeau

2019-05-14 17:45:22 +0000

[diff] [blame]

2696

describes the performance and errors of an identified virtual network

2697

interface card

Lusheng Ji