Intel® Cluster Checker API Documentation

已发布:11/10/2017   最后更新时间:11/10/2017

Class Reference

Here is a list of all documented classes with brief descriptions:

N  clck

 

    C  Fault

A fault is the basic analysis unit. A fault is either a sign (i.e., observation) or a diagnosis (i.e., root cause).

    C  Diagnosis

A diagnosis is the root cause of an issue. Diagnosis is derived from the Fault class.

    C  Sign

A sign is an observation of an issue. Sign is derived from the Fault class.

    C  Node

The node container.

    C  Layer

The presentation layer.

        S  CollectConfig

Data collect configuration.

        S  Config

Layer configuration options.

        S  ConfigParam

Data analysis configuration parameter.

        S  DatabaseConfig

A database used for collection and analysis.

        S  Filter

Filter for the list of faults returned by get_faults().

        S  Fwd

Framework definition configuration options.

        S  Message

Internal Layer messages for the caller to handle.

        S  ProviderConfigParam

Data collect configuration parameter.

        S  ProviderOptionset

Data collect configuration for option set.

        S  Sorting

Sort order for the list of faults returned by get_faults().

        S  Suppression

Suppress faults matching the specified values.

clck Namespace

Definition:
clck

Data Structures

class

Fault

A fault is the basic analysis unit. A fault is either a sign (i.e., observation) or a diagnosis (i.e., root cause).

class

Diagnosis

A diagnosis is the root cause of an issue. Diagnosis is derived from the Fault class.

class

Sign

A sign is an observation of an issue. Sign is derived from the Fault class.

class

Node

The node container.

class

Layer

The presentation layer.

Enumerations

enum

FaultType { DIAGNOSIS = 0, DIAGNOSED_SIGN, UNDIAGNOSED_SIGN }

Enumeration Type Documentation

enum FaultType

Fault types

Fault Class

Definition:
clck::Fault

A fault is the basic analysis unit. A fault is either a sign (i.e., observation) or a diagnosis (i.e., root cause).

#include <clck.h>

Derived classes: clck::Diagnosis, clck::Sign

Public Attributes

int

confidence = 0

std::string

id

std::string

msg

std::vector< std::string >

nodes

std::string

remedy

int

severity = 0

bool

suppressed = false

std::set< int >

rowid

Field Documentation

int confidence = 0

Confidence percentage (0 - 100)

std::string id

Message catalog id

std::string msg

Expanded message string

std::vector< std::string > nodes

List of nodes

std::string remedy

Expanded remedy string

int severity = 0

Severity percentage (0 - 100)

bool suppressed = false

True if the diagnosis / sign is suppressed, false otherwise

std::set< int > rowid

DB rows that provide the raw data upon which the sign/diagnosis is based

Diagnosis Class

Definition:
clck::Diagnosis

A diagnosis is the root cause of an issue. Diagnosis is derived from the Fault class.

#include <clck.h>

Base classes: clck::Fault

Sign Class

Definition:
clck::Sign

A sign is an observation of an issue. Sign is derived from the Fault class.

#include <clck.h>

Base classes: clck::Fault

Public Types

enum

{ DIAGNOSED, OBSERVED }

Public Attributes

enum clck::Sign::{ ... }

state

Field Documentation

enum clck::Sign::{ ... } state

Either diagnosed (meaning used to make a diagnosis) or observed (undiagnosed).

Node Class

Definition:
clck::Node

The node container.

#include <clck.h>

Public Types

enum

role_t { ROLE_BOOT, ROLE_COMPUTE, ROLE_ENHANCED, ROLE_EXTERNAL, ROLE_HEAD, ROLE_JOB_SCHEDULE, ROLE_LOGIN, ROLE_NETWORK_ADDRESS, ROLE_STORAGE }

Public Attributes

std::string

subcluster

std::string

name

std::vector< role_t >

roles

Member Type Documentation

enum role_t

Roles than a node can fulfill.

Field Documentation

std::string subcluster

A subcluster to which the node belongs.

std::string name

An unique node identifier, i.e., the hostname.

std::vector< role_t > roles

A list of roles that the node fulfills.

Layer Class

Definition:
clck::Layer

The presentation layer.

#include <clck.h>

Data Structures

struct

CollectConfig

Data collect configuration.

struct

Config

Layer configuration options.

struct

ConfigParam

Data analysis configuration parameter.

struct

DatabaseConfig

A database used for collection and analysis.

struct

Filter

Filter for the list of faults returned by get_faults().

struct

Fwd

Framework definition configuration options.

struct

Message

Internal Layer messages for the caller to handle.

struct

ProviderConfigParam

Data collect configuration parameter.

struct

ProviderOptionset

Data collect configuration for option set.

struct

Sorting

Sort order for the list of faults returned by get_faults().

struct

Suppression

Suppress faults matching the specified values.

Public Types

enum

ScaleType { SCALE_CONSTANT = 0, SCALE_LINEAR, SCALE_SQUARED, SCALE_LOGARITHMIC }

The scale attribute specifies the rate at which the timeout value should increase based on the number of nodes. Valid options are: constant, linear, squared, logarithmic.

enum

DatabaseType { SQLITE = 0, ODBC }

Supported database types.

Public Member Functions

 

Layer (const Config &config)

 

~Layer ()

bool

analyze (const std::vector< Suppression > &suppressions)

bool

collect ()

std::vector< std::shared_ptr< Fault > >

get_faults (const Filter &filter, const std::vector< Sorting > &sorting)

std::vector< Message >

get_messages ()

std::vector< Node >

get_nodes ()

int

get_version_number ()

bool

progress (unsigned long &remaining, unsigned long &completed)

Public Attributes

std::condition_variable

message

Member Type Documentation

enum ScaleType

The scale attribute specifies the rate at which the timeout value should increase based on the number of nodes. Valid options are: constant, linear, squared, logarithmic.

SCALE_CONSTANT = 0

The "constant" attribute value does not scale the timeout with the number of nodes used.

SCALE_LINEAR

The "linear" attribute value scales linearly with the number of nodes (e.g. base * num_nodes).

SCALE_SQUARED

The "squared" attribute value scales with the number of nodes squared (e.g. base * num_nodes^2).

SCALE_LOGARITHMIC

The "logarithmic" tag scales logarithmically with the number of nodes (e.g. base * ln((e-1) + num_nodes)).

Constructor & Destructor Documentation

Layer ( const Config & config )

Layer constructor

~Layer ( )  

Layer destructor

Member Function Documentation

bool analyze ( const std::vector< Suppression > & suppressions )

Start the analysis. Note: behavior is undefined if invoked more than once per Layer instance.

Returns:

True if the analysis was completed successfully, false otherwise. Note: this does NOT reflect the state of the cluster.

bool collect ( )  

Collect data.

Returns:

True if the data collection was completed successfully, false otherwise.

std::vector< std::shared_ptr< Fault > > get_faults ( const Filter & filter,  
    const std::vector< Sorting > & sorting  
  )  

Returns a list of faults. May be called multiple times. While analyze() is active, presumably in another thread, the behavior is undefined. Use progress() to determine current analysis status. If called before analyze(), returns an empty list.

Parameters:

filter

Return only faults that match the filter

sorting

List of sorting criteria. The first element is the primary sorting criterion, the second element the secondary sorting criterion, etc. If empty, the faults are returned unsorted.

Returns:

A list of faults

std::vector< Message > get_messages ( )  

Returns a list of messages generated internal to Layer for the caller to handle.

Returns:

A list of messages

std::vector< Node > get_nodes ( )  

Returns the list of nodes to be analyzed.

Returns:

A list of nodes.

int get_version_number ( )  

Returns the version of the Layer API.

Returns:

The version number. Version X.Y.Z is represented as (X*1000000 + Y*1000 + Z).

bool progress ( unsigned long & remaining,  
    unsigned long & completed  
  )  

While analyze() is active, presumably in another thread, returns the number of rules remaining to be fired and the number of rules already run. If called before analyze(), both values will be 0.

Parameters:

remaining

The number of rules remaining to be fired. Not guaranteed to be monotonic. Returned by reference.

completed

The number of rules that have been fired. Will be monotonic. Returned by reference.

Returns:

False if analyze() has not yet been called, true otherwise.

Field Documentation

std::condition_variable message

Notify when a new internal Layer message is available

CollectConfig Struct

Definition:
clck::Layer::CollectConfig

Data collect configuration.

#include <clck.h>

Public Attributes

bool

ignore_subclusters = false

bool

run_all_providers = false

bool

run_async = false

char

provider_async_output_dir [PATH_MAX]

char

provider_path [PATH_MAX]

char

provider_aux_path [PATH_MAX]

unsigned int

cluster_permutations = 1

int

database_close_delay = 1

enum ScaleType

scale = ScaleType::SCALE_CONSTANT

std::string

network_interface = ""

std::string

shared_dir

time_t

timeout = 60

std::vector< ProviderConfigParam >

provider_config_params

Field Documentation

bool ignore_subclusters = false

Ignores the sub-clustering of nodes.

bool run_all_providers = false

Runs all providers specified at provider_config_dir location.

bool run_async = false

Runs asynchronously when set to true for ORCM.

char provider_async_output_dir [PATH_MAX]

Provider Asynchronous Output Directory.

char provider_path [PATH_MAX]

Provider Config Directory Path.

char provider_aux_path [PATH_MAX]

Provider Auxiliary Path.

unsigned int cluster_permutations = 1

Cluster permutations, 0 means all.

int database_close_delay = 1

Time to delay the closing of database connection in seconds.

enum ScaleType scale = ScaleType::SCALE_CONSTANT

The scale attribute specifies the rate at which the timeout value should increase based on the number of nodes. Default is set to constant.

std::string network_interface = ""

Network interface.

std::string shared_dir

Shared Directory to store intermittent files.

Note: Currently, this variable is not configurable. Internally, the value is defaulted to $HOME/.clck

time_t timeout = 60

Time out for the Provider. Default is 60 seconds.

std::vector< ProviderConfigParam > provider_config_params

Data collect configuration parameters

Config Struct

Definition:
clck::Layer::Config

Layer configuration options.

#include <clck.h>

Public Types

enum

{ DATABASE, NODELIST, INTERSECTION, UNION }

Public Member Functions

 

Config () =default

 

Config (const std::vector< DatabaseConfig > &db_configs)

Public Attributes

CollectConfig

collect_config

std::vector< Fwd >

fwds

std::vector< std::string >

fwd_file_list

std::string

bin_path

std::vector< DatabaseConfig >

db_configs

time_t

expiration = 0

std::string

install_path

std::string

language

std::vector< Node >

nodes

enum clck::Layer::Config::{ ... }

node_source = DATABASE

time_t

now = time(NULL)

std::vector< std::string >

providers

std::string

provider_path

std::vector< ConfigParam >

config_params

Detailed Description

Layer configuration options.

Additional configuration options are likely to be added in the future, as needed.

Constructor & Destructor Documentation

Config ( ) =default

Default constructor

Config ( const std::vector< DatabaseConfig > & db_configs )

Constructor

Parameters:

db_configs

List of database configurations

Field Documentation

CollectConfig collect_config

Collect configuration

std::vector< Fwd > fwds

List of Framework definitions

std::vector< std::string > fwd_file_list

List of Framework definition files to be loaded

std::string bin_path

Optional path to the binary directory. If it is not specified, then the bin path under the install path will be used.

std::vector< DatabaseConfig > db_configs

List of database configurations

time_t expiration = 0

Maximum allowable age of data, relative to the value of now. Data older than now minus expiration will be ignored. A value of 0 means to use all data, i.e., there is no expiration.

std::string install_path

Optional path of the Intel(R) Cluster Checker installation. If is is not specified, then the default install path will be used.

std::string language

String representing the message catalog language

std::vector< Node > nodes

List of nodes to be analyzed (see node_source).

enum clck::Layer::Config::{ ... } node_source = DATABASE

Select the source for the list of nodes. Options are to use the database (exclusively), the input nodes vector (exclusively), or the intersection or union of the two.

time_t now = time(NULL)

Reference time to be used as the current time for analysis

std::vector< std::string > providers

List of providers to run. The providers are XML files that are located in the provider path. When specifying a provider, do not include the .xml extension. If a user intends to run a provider defined in dgemm.xml, then just append dgemm to the list of providers.

std::string provider_path

Optional path to the provider XML files. If it is not specified then the provider path under the install path will be used.

std::vector< ConfigParam > config_params

Data analysis configuration parameters

ConfigParam Struct

Definition:
clck::Layer::ConfigParam

Data analysis configuration parameter.

#include <clck.h>

Public Attributes

std::string

module

std::string

provider

std::string

provider_optionset

std::string

key

std::vector< std::string >

values

Detailed Description

Data analysis configuration parameter.

Note: For collect configuration, use ProviderConfigParam struct

Field Documentation

std::string module

Module name in the knowledge base

std::string provider

Provider name for data collection

std::string provider_optionset

Provider optionset

std::string key

Parameter name

std::vector< std::string > values

Parameter value(s)

DatabaseConfig Struct

Definition:
clck::Layer::DatabaseConfig

A database used for collection and analysis.

#include <clck.h>

Public Attributes

DatabaseType

type

std::string

name

std::string

source

Field Documentation

DatabaseType type

Database type

std::string name

Database name

std::string source

Database source

Filter Struct

Definition:
clck::Layer::Filter

Filter for the list of faults returned by get_faults().

#include <clck.h>

Public Attributes

int

confidence = 0

std::vector< std::string >

ids

std::vector< std::string >

nodes

int

severity = 0

std::bitset< 2 >

state = CLCK_FAULT_STATE_DIAGNOSED | CLCK_FAULT_STATE_OBSERVED

std::bitset< 2 >

suppressed = CLCK_FAULT_SUPPRESSED_FALSE

std::bitset< 2 >

type = CLCK_FAULT_TYPE_DIAGNOSIS | CLCK_FAULT_TYPE_SIGN

Field Documentation

int confidence = 0

Select faults with a greater than or equal to confidence value.

std::vector< std::string > ids

Select faults corresponding to at least one of the ids. If empty, does not filter on id.

std::vector< std::string > nodes

Selects faults corresponding to at least one of the nodes. If empty, does not filter on node.

int severity = 0

Select faults with a greater than or equal to severity value.

std::bitset< 2 > state = CLCK_FAULT_STATE_DIAGNOSED | CLCK_FAULT_STATE_OBSERVED

Select faults with a matching state. Only applies to signs, not diagnoses.

std::bitset< 2 > suppressed = CLCK_FAULT_SUPPRESSED_FALSE

Select faults with a matching suppression value.

std::bitset< 2 > type = CLCK_FAULT_TYPE_DIAGNOSIS | CLCK_FAULT_TYPE_SIGN

Select faults with a matching type.

Fwd Struct

Definition:
clck::Layer::Fwd

Framework definition configuration options.

#include <clck.h>

Public Member Functions

 

Fwd () =default

 

Fwd (const std::vector< std::string > &providers, const std::set< std::string > &extension_mods, const std::vector< std::string > &kb_mods, const std::string &provider_path = "", const std::string &provider_aux_path = "", const std::string &extension_path = "", const std::string &kb_path = "")

Public Attributes

std::string

name

std::vector< std::string >

providers

std::string

provider_path

std::string

provider_aux_path

std::set< std::string >

extension_mods

std::string

extension_path

std::vector< std::string >

kb_mods

std::string

kb_path

Constructor & Destructor Documentation

Fwd ( ) =default

Default constructor

Fwd ( const std::vector< std::string > & providers,  
    const std::set< std::string > & extension_mods,  
    const std::vector< std::string > & kb_mods,  
    const std::string & provider_path = "",  
    const std::string & provider_aux_path = "",  
    const std::string & extension_path = "",  
    const std::string & kb_path = ""  
  )  

Constructor

Parameters:

providers

List of providers to be loaded

extension_mods

List of connector extensions to be loaded

kb_mods

List of knowledge base files to be loaded

provider_path

Absolute path to the provider directory

provider_aux_path

Absolute path to the provider auxiliary directory

extension_path

Absolute path to the connector extension directory

kb_path

Absolute path to the knowledge base directory

Field Documentation

std::string name

A unique Framework definition identifier.

std::vector< std::string > providers

List of providers to be loaded

std::string provider_path

Absolute path to the provider directory

std::string provider_aux_path

Absolute path to the provider auxiliary directory

std::set< std::string > extension_mods

List of connector extensions to be loaded

std::string extension_path

Absolute path to the connector extension directory

std::vector< std::string > kb_mods

List of knowledge base files to be loaded

std::string kb_path

Absolute path to the knowledge base directory

Message Struct

Definition:
clck::Layer::Message

Internal Layer messages for the caller to handle.

#include <clck.h>

Public Attributes

int

level

std::string

msg

Field Documentation

int level

Message level (priority). Inherits logging levels from syslog.

std::string msg

Message string

ProviderConfigParam Struct

Definition:
clck::Layer::ProviderConfigParam

Data collect configuration parameter.

#include <clck.h>

Public Attributes

std::string

provider

std::vector< ProviderOptionset >

provider_optionsets

Field Documentation

std::string provider

Provider name for data collection

std::vector< ProviderOptionset > provider_optionsets

Provider optionsets for provider

ProviderOptionset Struct

Definition:
clck::Layer::ProviderOptionset

Data collect configuration for option set.

#include <clck.h>

Public Attributes

std::string

id

std::map< std::string, std::string >

provider_option_vars

Field Documentation

std::string id

Provider Optionset

std::map< std::string, std::string > provider_option_vars

Provider Key=Value Parameters

Sorting Struct

Definition:
clck::Layer::Sorting

Sort order for the list of faults returned by get_faults().

#include <clck.h>

Public Types

enum

FIELD { CONFIDENCE, ID, NODE, SEVERITY }

Public Member Functions

 

Sorting (bool ascending, decltype(field) field)

Public Attributes

bool

ascending = true

enum clck::Layer::Sorting::FIELD

field

Member Type Documentation

enum FIELD

Fault Fields to sort on

Constructor & Destructor Documentation

Sorting ( bool ascending,  
    decltype(field) field  
  )  

Sorting constructor

Field Documentation

bool ascending = true

If true, sort in ascending order, otherwise sort in descending order.

enum clck::Layer::Sorting::FIELD field

The field attribute specifies the field to sort on

Suppression Struct

Definition:
clck::Layer::Suppression

Suppress faults matching the specified values.

#include <clck.h>

Public Attributes

int

confidence = 0

std::string

id

std::string

node

int

severity = 0

Field Documentation

int confidence = 0

Suppress all faults with a value less than the confidence value.

std::string id

Suppress all messages with a matching id. If empty, does not suppress on id.

std::string node

Supress all messages containing the node value. If empty, does not suppress on node.

int severity = 0

Suppress all faults with a value less than the severity value.

File Reference

Here is a list of all documented files with brief descriptions:

clck.h

Data Structures

class

clck::Fault

A fault is the basic analysis unit. A fault is either a sign (i.e., observation) or a diagnosis (i.e., root cause).

class

clck::Diagnosis

A diagnosis is the root cause of an issue. Diagnosis is derived from the Fault class.

class

clck::Sign

A sign is an observation of an issue. Sign is derived from the Fault class.

class

clck::Node

The node container.

class

clck::Layer

The presentation layer.

struct

clck::Layer::ProviderOptionset

Data collect configuration for option set.

struct

clck::Layer::ProviderConfigParam

Data collect configuration parameter.

struct

clck::Layer::CollectConfig

Data collect configuration.

struct

clck::Layer::ConfigParam

Data analysis configuration parameter.

struct

clck::Layer::DatabaseConfig

A database used for collection and analysis.

struct

clck::Layer::Fwd

Framework definition configuration options.

struct

clck::Layer::Config

Layer configuration options.

struct

clck::Layer::Filter

Filter for the list of faults returned by get_faults().

struct

clck::Layer::Message

Internal Layer messages for the caller to handle.

struct

clck::Layer::Sorting

Sort order for the list of faults returned by get_faults().

struct

clck::Layer::Suppression

Suppress faults matching the specified values.

Namespaces

namespace

clck

Macros

#define

CLCK_LAYER_VERSION_NUMBER 2018001000

#define

CLCK_FAULT_STATE_DIAGNOSED 1

#define

CLCK_FAULT_STATE_OBSERVED 2

#define

CLCK_FAULT_SUPPRESSED_TRUE 1

#define

CLCK_FAULT_SUPPRESSED_FALSE 2

#define

CLCK_FAULT_TYPE_DIAGNOSIS 1

#define

CLCK_FAULT_TYPE_SIGN 2

产品和性能信息

1

英特尔的编译器针对非英特尔微处理器的优化程度可能与英特尔微处理器相同(或不同)。这些优化包括 SSE2、SSE3 和 SSSE3 指令集和其他优化。对于在非英特尔制造的微处理器上进行的优化,英特尔不对相应的可用性、功能或有效性提供担保。该产品中依赖于微处理器的优化仅适用于英特尔微处理器。某些非特定于英特尔微架构的优化保留用于英特尔微处理器。关于此通知涵盖的特定指令集的更多信息,请参阅适用产品的用户指南和参考指南。

通知版本 #20110804