SAP ABAP Class CL_SPI_STAT_COLLECTOR (Collector for Performance Data)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-SRV-PMI (Application Component) Process Monitoring Infrastructure
⤷
SPI14 (Package) Central: Statistics Tools
⤷
⤷
Properties
| Class | CL_SPI_STAT_COLLECTOR | |
| Short Description | Collector for Performance Data | |
| Super Class | ||
| Instantiability of a Class | 1 | Protected |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | SPI14 | Central: Statistics Tools |
| Created | 20040429 | SAP |
| Last change | 20110908 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) | |
| 2 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) | |
| 3 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class CL_SPI_STAT_COLLECTOR has no interface implemented.
Friends
| # | Friend | Modeled only | Created on | Description |
|---|---|---|---|---|
| 1 | CL_SPI_STAT_READ | 20040721 | Superclass for Reading STATs | |
| 2 | CL_SPI_STAT_READ_R3 | 20040721 | Reading R/3 Statistics without GUID |
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Constant | Private | Type reference (TYPE) | ALCUSGROUP | 'Enqueue:' | CCMS Attribute: Statistics lock still set | 20040721 | ||
| 2 | Constant | Private | Type reference (TYPE) | ALCUSGROUP | 'New Sets of CollectorParams:' | CCMS attribute: New collector parameter from TR records | 20040721 | ||
| 3 | Constant | Private | Type reference (TYPE) | ALCUSGROUP | SPACE | No CCMS attribute, message for application log only. | 20040721 | ||
| 4 | Constant | Private | Type reference (TYPE) | ALCUSGROUP | 'No StatRec.s Found:' | CCMS Attribute: Number of Fitting Statistical Records Found | 20040726 | ||
| 5 | Constant | Private | Type reference (TYPE) | ALCUSGROUP | 'Sets of Coll.Params from DB:' | CCMS Attribute: 'Old' Collector Parameters from the DB | 20040721 | ||
| 6 | Constant | Private | Type reference (TYPE) | ALCUSGROUP | 'No Statistic Records Stored:' | CCMS Attribute: Number of Statistical Records Temp. Stored | 20040721 | ||
| 7 | Constant | Private | Type reference (TYPE) | ALCUSGROUP | 'Shared Memory:' | CCMS Attribute: Shared Memory - Invalidation | 20040721 | ||
| 8 | Constant | Private | Type reference (TYPE) | ALCUSGROUP | 'Statistic Read Error:' | CCMS Attribute: Error While Reading Statistics | 20040726 | ||
| 9 | Constant | Private | Type reference (TYPE) | SYMSGID | 'SPI14' | Message ID for Application Log | 20040721 | ||
| 10 | Constant | Public | Type reference (TYPE) | SPISTTTL | '1' | Liftetime for Coll. Params for Reading TransIDs (# Runs) | 20040819 | ||
| 11 | Instance attribute | Private | Object reference (TYPE REF TO) | CL_SPI_SELF_MONITOR | Log Reference of Transport | 20040720 | |||
| 12 | Instance attribute | Private | Type reference (TYPE) | SYDATUM | Read End Time of Transport | 20040506 | |||
| 13 | Instance attribute | Private | Type reference (TYPE) | SYUZEIT | Read End Time of Transport | 20040429 | |||
| 14 | Instance attribute | Private | Type reference (TYPE) | SYDATUM | Read Start Time of Transport | 20040511 | |||
| 15 | Instance attribute | Private | Type reference (TYPE) | SYUZEIT | Read Start Time of Transport | 20040511 | |||
| 16 | Instance attribute | Private | Type reference (TYPE) | TSPISTRECS | Table for Saving All Compressed Statistics | 20040429 | |||
| 17 | Instance attribute | Private | Type reference (TYPE) | TSPIPROCDEST | Log References for Process-Dependent Logs | 20040721 | |||
| 18 | Instance attribute | Private | Type reference (TYPE) | SPIST_TPROC_STEPS | Table of Process Step Names for Logs | 20040721 | |||
| 19 | Instance attribute | Private | Type reference (TYPE) | TSPISTCONF | Configuration & Destinations for Performance Data Analysis | 20040503 | |||
| 20 | Instance attribute | Private | Type reference (TYPE) | TSPIROX2 | Tracking Records Read From Transport | 20040429 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Constructor | Constructor | 20040429 | |
| 2 | Instance method | Private | Method | Process-Dependent Logs: Specify Affected Process Steps | 20040721 | |
| 3 | Instance method | Private | Method | Create Process-Dependent Logs | 20040721 | |
| 4 | Instance method | Private | Method | Define Statistics Read Parameters from Current TRs | 20040503 | |
| 5 | Instance method | Private | Method | Make STAT Function Module Import Param. from "Coll. Param." | 20040510 | |
| 6 | Static method | Public | Method | Create Collector Instance, Specify Read TRs | 20040429 | |
| 7 | Static method | Public | Method | Determine Expiry Date and Expiry Time | 20040504 | |
| 8 | Instance method | Private | Method | Get "Old" Statistics Read Parameters from DB (Retry & TIDs) | 20040503 | |
| 9 | Instance method | Private | Method | Read Statistics Configuration and Destinations | 20040503 | |
| 10 | Instance method | Private | Method | Merge and Save Collector Parameters (for Lock Problems) | 20040506 | |
| 11 | Instance method | Private | Method | Transfer Previously Read TransIDs to New Time Period | 20040506 | |
| 12 | Instance method | Private | Method | Generate Collector Parameters to be Saved (Retry & Read) | 20040823 | |
| 13 | Instance method | Private | Method | Delete Statistics Read Lock | 20040503 | |
| 14 | Instance method | Private | Method | Save Statistics | 20040429 | |
| 15 | Instance method | Private | Method | Set Statistics Read Lock | 20040503 | |
| 16 | Instance method | Public | Method | Starts Collector | 20040429 | |
| 17 | Instance method | Private | Method | After Reading: Revise Collector Parameters in DB | 20040512 | |
| 18 | Instance method | Private | Method | Convert UTC Time to System Time | 20040503 | |
| 19 | Instance method | Private | Method | Save New Collector Parameters (ONLY new!) | 20040506 |
Events
Class CL_SPI_STAT_COLLECTOR has no event.
Types
Class CL_SPI_STAT_COLLECTOR has no local type.
Method Signatures
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IO_PROTOCOL | Call by reference | Object reference (TYPE REF TO) | CL_SPI_SELF_MONITOR | Protokollreferenz des Transports | 20040720 | |||
| 2 | IP_READ_END_TIME | Call by reference | Type reference (TYPE) | TIMESTAMPL | Leseendzeitpunkt des Transports | 20040429 | |||
| 3 | IT_DEST | Call by reference | Type reference (TYPE) | TSPISTST | Vom Transport genutzte Destinations (=> Startzeitpunkt) | 20040512 | |||
| 4 | IT_PROC_PROT | Call by reference | Type reference (TYPE) | TSPIPROCDEST | Processtypabhängige Protokollreferenzen | 20040721 | |||
| 5 | IT_TR_RECS | Call by reference | Type reference (TYPE) | TSPIROX2 | Vom Transport gelesene Tracking Records | 20040429 |
Method CONSTRUCTOR on class CL_SPI_STAT_COLLECTOR has no exception.
Method CREATE_PROCPROT_STEPS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IP_DETLEVEL | Call by reference | Type reference (TYPE) | BALLEVEL | '4' | Anwendungs-Log: Detaillierungsgrad | 20040721 | ||
| 2 | IP_VALUE | Call by reference | Type reference (TYPE) | ALVALUE | CL_SPI_SELF_MONITOR=>CP_VALUE_GREEN | Alert: alert value (1 = green, 2 = yellow, ....) | 20040721 | ||
| 3 | IS_PROC_PROT | Call by reference | Type reference (TYPE) | SSPIPROCDEST | SPI: Prozess u. -steps einer Destination (Protok. Transp.) | 20040721 |
Method CREATE_PROCPROT_STEPS on class CL_SPI_STAT_COLLECTOR has no exception.
Method CREATE_PROC_PROT_ENTRIES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IP_DESTINATION | Call by reference | Type reference (TYPE) | SPIPRSTDEST | Lese-Destination für Perf.-Daten | 20040721 | |||
| 2 | IP_DETLEVEL | Call by reference | Type reference (TYPE) | BALLEVEL | '3' | Anwendungs-Log: Detaillierungsgrad | 20040721 | ||
| 3 | IP_EXCEPTION | Call by reference | Object reference (TYPE REF TO) | CX_ROOT | Abstrakte Oberklasse aller globalen Exceptions | 20040721 | |||
| 4 | IP_MSGNO | Call by reference | Type reference (TYPE) | SYMSGNO | Nachrichten, Nachrichtennummer | 20040721 | |||
| 5 | IP_MSGV_1 | Call by reference | Type reference (TYPE) | SYMSGV | Nachrichten, Nachrichtenvariable | 20040721 | |||
| 6 | IP_MSGV_2 | Call by reference | Type reference (TYPE) | SYMSGV | Nachrichten, Nachrichtenvariable | 20040721 | |||
| 7 | IP_MSGV_3 | Call by reference | Type reference (TYPE) | SYMSGV | Nachrichten, Nachrichtenvariable | 20040721 | |||
| 8 | IP_VALUE | Call by reference | Type reference (TYPE) | ALVALUE | CL_SPI_SELF_MONITOR=>CP_VALUE_GREEN | Alert: alert value (1 = green, 2 = yellow, ....) | 20040721 | ||
| 9 | IP_WITH_STEPS | Call by reference | Type reference (TYPE) | SPIBOOL | SPI_FALSE | Betroffene Schritte untergeordnet angeben? | 20040721 |
Method CREATE_PROC_PROT_ENTRIES on class CL_SPI_STAT_COLLECTOR has no exception.
Method CREATE_READ_PARAMS_FROM_TRS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IP_WITH_PROT | Call by reference | Type reference (TYPE) | SPIBOOL | SPI_FALSE | Protokollierung der Kollektorparameter? | 20040802 | ||
| 2 | RT_COL_PARS | Value transfer | Type reference (TYPE) | TSPISTCLPR | Kollektorparameter zum Lesen der Perf.-Daten | 20040503 |
Method CREATE_READ_PARAMS_FROM_TRS on class CL_SPI_STAT_COLLECTOR has no exception.
Method CREATE_STAT_FUBAU_PARAMS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_FB_PARS | Call by reference | Type reference (TYPE) | TSPISTFBPR | Funktionsbausteinparameter zum Lesen der Perf.-Daten | 20040510 | |||
| 2 | IP_WITH_PROT | Call by reference | Type reference (TYPE) | SPIBOOL | SPI_FALSE | Mit erweitertem Protokoll? | 20040809 | ||
| 3 | IT_DB_COLL_PARS | Call by reference | Type reference (TYPE) | TSPISTCLPR | Kollektorparameter von DB | 20040823 | |||
| 4 | IT_NEW_COLL_PARS | Call by reference | Type reference (TYPE) | TSPISTCLPR | "Neue" Kollektorparameter | 20040512 |
Method CREATE_STAT_FUBAU_PARAMS on class CL_SPI_STAT_COLLECTOR has no exception.
Method GET_COLLECTOR_INSTANCE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IO_PROTOCOL | Call by reference | Object reference (TYPE REF TO) | CL_SPI_SELF_MONITOR | Protokollreferrenz des Transports | 20040720 | |||
| 2 | IP_READ_END_TIME | Call by reference | Type reference (TYPE) | TIMESTAMPL | Leseendzeitpunkt des Transports | 20040429 | |||
| 3 | IT_DEST | Call by reference | Type reference (TYPE) | TSPISTST | Vom Transport genutzte Destinations (=> Startzeitpunkt) | 20040512 | |||
| 4 | IT_PROC_PROT | Call by reference | Type reference (TYPE) | TSPIPROCDEST | Prozesstypabhängige Protokollreferrenzen | 20040721 | |||
| 5 | IT_TR_RECS | Call by reference | Type reference (TYPE) | TSPIROX2 | Tabelle der vom Transport gelesenen Records | 20040429 | |||
| 6 | RO_STAT_COLLECTOR | Value transfer | Object reference (TYPE REF TO) | CL_SPI_STAT_COLLECTOR | Kollektor für Performance-Daten | 20040429 |
Method GET_COLLECTOR_INSTANCE on class CL_SPI_STAT_COLLECTOR has no exception.
Method GET_EXPIRATION_TIME Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EP_EXP_DATE | Call by reference | Type reference (TYPE) | SY-DATUM | Verfallstag | 20040504 | |||
| 2 | EP_EXP_TIME | Call by reference | Type reference (TYPE) | SY-UZEIT | Verfallszeit | 20040504 | |||
| 3 | IP_STATEXPIRE | Call by reference | Type reference (TYPE) | SPISTEXPTI | Perf.Daten in PMI, Konfig: Verfallszeit der Statistik in min | 20040504 |
Method GET_EXPIRATION_TIME on class CL_SPI_STAT_COLLECTOR has no exception.
Method GET_READ_PARAMS_FROM_DB Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IP_WITH_PROT | Call by reference | Type reference (TYPE) | SPIBOOL | SPI_FALSE | Kollektorparameter protokollieren? | 20040802 | ||
| 2 | RT_COL_PARS | Value transfer | Type reference (TYPE) | TSPISTCLPR | Kollektorparameter zum Lesen der Perf.-Daten | 20040503 |
Method GET_READ_PARAMS_FROM_DB on class CL_SPI_STAT_COLLECTOR has no exception.
Method GET_STAT_CONFIG Signature
Method GET_STAT_CONFIG on class CL_SPI_STAT_COLLECTOR has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Konfiguration der Perf.-Daten-Erfassung | 20040719 |
Method IN_CASE_OF_ENQUEUE_FAILURE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IT_DB_COL_PARS | Call by reference | Type reference (TYPE) | TSPISTCLPR | Kollektorparameter von DB | 20040506 | |||
| 2 | IT_NEW_COL_PARS | Call by reference | Type reference (TYPE) | TSPISTCLPR | Kollektorparameter aus akt. TR's | 20040506 | |||
| 3 | R_COL_PARS_STORED | Value transfer | Type reference (TYPE) | SYDBCNT | Anzahl gespeicherter Kollektorparameter | 20040720 |
Method IN_CASE_OF_ENQUEUE_FAILURE on class CL_SPI_STAT_COLLECTOR has no exception.
Method MOVE_TRANSIDS_TO_NEW_TIMEFRAME Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CT_DB_COL_PARS | Call by reference | Type reference (TYPE) | TSPISTCLPR | Von der DB gelesene Kollektorparameter | 20040819 | |||
| 2 | ET_NEW_COL_PARS | Call by reference | Type reference (TYPE) | TSPISTCLPR | Daraus resultierende Kolektorparameter | 20040819 | |||
| 3 | IP_WITH_PROT | Call by reference | Type reference (TYPE) | SPIBOOL | SPI_FALSE | Mit erweitertem Protokoll? | 20040809 |
Method MOVE_TRANSIDS_TO_NEW_TIMEFRAME on class CL_SPI_STAT_COLLECTOR has no exception.
Method OVERWORK_COL_PARS_TO_BE_STORED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IT_COLPARS_FROM_INST_ERROR | Call by reference | Type reference (TYPE) | TSPISTCLPR | Kollektorparameteraus jetzigen Instanzfehlern | 20040823 | |||
| 2 | IT_COLPARS_FROM_RETRY | Call by reference | Type reference (TYPE) | TSPISTCLPR | Kollektorparameter aus früheren Lesefehlern | 20040823 | |||
| 3 | IT_FB_PARS | Call by reference | Type reference (TYPE) | TSPISTFBPR | Funktionsbausteinparameter mit Leseergebnissen (read_done) | 20040823 | |||
| 4 | IT_USED_COLPARS | Call by reference | Type reference (TYPE) | TSPISTCLPR | Alle genutzten Kollektorparameter (außer frühere Lesefehler) | 20040823 | |||
| 5 | RT_COLPARS_TO_STORE | Value transfer | Type reference (TYPE) | TSPISTCLPR | Abzuspeichernde Kollektorparameter | 20040823 |
Method OVERWORK_COL_PARS_TO_BE_STORED on class CL_SPI_STAT_COLLECTOR has no exception.
Method RELEASE_ENQUEUE Signature
Method RELEASE_ENQUEUE on class CL_SPI_STAT_COLLECTOR has no parameter.
Method RELEASE_ENQUEUE on class CL_SPI_STAT_COLLECTOR has no exception.
Method SAVE_COMPRESSED_STATS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IP_WITH_COMMIT | Call by reference | Type reference (TYPE) | SPIBOOL | SPI_FALSE | SPI Global: Boolscher Wert | 20040519 | ||
| 2 | IT_ALL_STATS | Call by reference | Type reference (TYPE) | TSPISTRECS | Komprim. Statistiksätze zum Verdichten (Zwischenspeichern) | 20040519 | |||
| 3 | R_RECS_STORED | Value transfer | Type reference (TYPE) | SYDBCNT | Anzahl gespeicherter Sätze | 20040720 |
Method SAVE_COMPRESSED_STATS on class CL_SPI_STAT_COLLECTOR has no exception.
Method SET_ENQUEUE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RP_ENQUEUED | Value transfer | Type reference (TYPE) | SPIBOOL | Erfolgreich gesperrt | 20040622 |
Method SET_ENQUEUE on class CL_SPI_STAT_COLLECTOR has no exception.
Method START_COLLECTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IP_WITH_EXT_PROT | Call by reference | Type reference (TYPE) | SPIBOOL | SPI_FALSE | Mit erweitertem Protokoll? | 20040810 |
Method START_COLLECTOR on class CL_SPI_STAT_COLLECTOR has no exception.
Method UPDATE_COL_PARS_IN_DB Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IP_WITH_COMMIT | Call by reference | Type reference (TYPE) | SPIBOOL | SPI_FALSE | SPI Global: Boolscher Wert | 20040519 | ||
| 2 | IT_COL_PARS_TO_BE_STORED | Call by reference | Type reference (TYPE) | TSPISTCLPR | Neue, abzuspeichernde Kollektorparamter | 20040519 | |||
| 3 | R_COL_PARS_STORED | Value transfer | Type reference (TYPE) | SYDBCNT | Anzahl Kollektorparameter gespeichert | 20040720 |
Method UPDATE_COL_PARS_IN_DB on class CL_SPI_STAT_COLLECTOR has no exception.
Method UTC_TIME_TO_SYSTEM_TIME Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CP_DATE | Call by reference | Type reference (TYPE) | SY-DATUM | Datum und Zeit, aktuelles (Applikationsserver-)Datum | 20040503 | |||
| 2 | CP_TIME | Call by reference | Type reference (TYPE) | SY-UZEIT | Datum und Zeit, aktuelle (Applikationsserver-) Uhrzeit | 20040503 |
Method UTC_TIME_TO_SYSTEM_TIME on class CL_SPI_STAT_COLLECTOR has no exception.
Method WRITE_COL_PARS_TO_DB Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IP_WITH_COMMIT | Call by reference | Type reference (TYPE) | SPIBOOL | SPI_FALSE | mit Commit Work? | 20040506 | ||
| 2 | IT_NEW_COL_PARS | Call by reference | Type reference (TYPE) | TSPISTCLPR | Zu speichernde Kollektorparameter | 20040506 | |||
| 3 | R_COL_PARS_STORED | Value transfer | Type reference (TYPE) | SYDBCNT | Anzahl neuer abgespeicherter Kollektorparameter | 20040720 |
Method WRITE_COL_PARS_TO_DB on class CL_SPI_STAT_COLLECTOR has no exception.
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in | 700 |