Configuring Bulkstats

Contents

1Configuring Bulkstats
1.1Function of Bulkstats
1.2Data Collected by Bulkstats
1.3Application of Bulkstats to an Entity
1.4Configuring Bulkstats Policies
1.5Create or Modify a Bulkstats Schema Profile
1.6Displaying Bulkstats Configuration

2

Examples
2.1Examples: Create or Modify a Bulkstats Policy
2.2Specify the Primary File Server for a Bulkstats Policy
2.3Example: Create and Apply a Bulkstats Global Schema Profile
2.4Example: Apply a Bulkstats ATM Schema Profile
Copyright

© Ericsson AB 2010. All rights reserved. No part of this document may be reproduced in any form without the written permission of the copyright owner.

Disclaimer

The contents of this document are subject to revision without notice due to continued progress in methodology, design and manufacturing. Ericsson shall have no liability for any error or damage of any kind resulting from the use of this document.

Trademark List
SmartEdge  is a registered trademark of Telefonaktiebolaget LM Ericsson.
NetOp  is a trademark of Telefonaktiebolaget LM Ericsson.

1   Configuring Bulkstats

This document describes the bulkstats function, including data collected by bulkstats, application of bulkstats to an entity, configuring bulkstats policies, and schema profiles.

1.1   Function of Bulkstats

The bulkstats feature gathers large amounts of data from the SmartEdge® router and periodically sends updates to a management station. The bulkstats feature frees both the SmartEdge router and the management station from the Simple Network Management Protocol (SNMP) polling processes and minimizes the amount of memory used by the SmartEdge router for statistics collection.

The collection of data is governed by a named bulkstats policy. Bulkstats policies are context-specific and multiple bulkstats polices can exist for each context. A bulkstats policy defines the collection information, such as the transfer interval, the server to which the data files are sent, and the sampling interval.

1.2   Data Collected by Bulkstats

The types of data that are collected are governed by a bulkstats schema profile; it defines the type and format of data that is collected and acts as a template which, when applied to the system or to a context, subscriber, port, channel, or permanent virtual circuit (PVC), results in the collection of the data specified by the schema profile. There are two types of schema profiles: global (for collecting system-wide data) and specific (for collecting data for a specific type of entity).

Because the type of data that can be collected varies for each type of entity, there are different types of schema profiles, specific to the entity being monitored: contexts, ports, subscribers, channels, Asynchronous Transfer Mode (ATM), Frame Relay and 802.1Q PVCs, and link-groups. A bulkstats schema profile also describes the format in which the data displays. A bulkstats schema profile consists of a name, a display format, and a list of statistics.

Bulkstats schema profiles employ a format string that uses special-character sequences to identify the data type for the statistics variables in the format strings; see Format String Special Character Descriptions. Format strings are replaced with SmartEdge router variables, such as system uptime, date, time of day, port and slot number information, and more. Supported SmartEdge router variables vary according to the type of schema profile. These variables are defined in the description of the bulkstats schema profile command.

1.3   Application of Bulkstats to an Entity

When a bulkstats schema profile is applied to an entity, such as a port, a bulkstats policy is also applied together with the context in which the bulkstats policy is configured. Data is collected and transferred to a management station as follows:

  1. The SmartEdge router samples and stores system, network, and traffic statistics at specified sampling intervals. Information can be collected at the system, port, channel, and circuit levels. Bulkstats data is stored as continuous counter values.
  2. At specified transfer intervals, bulkstats data is transferred to a network management station acting as a file server. The file transfer mechanism can be File Transfer Protocol (FTP), Secure Shell FTP (SSH FTP), or Secure Copy Protocol (SCP). The file data comprises of lines of ASCII text.
  3. When the file is successfully transmitted, the information is deleted from the SmartEdge router memory.

Before you enable bulkstats collection for a policy, you must configure the following elements for an existing bulkstats policy:

  1. Specify the primary bulkstats file server and file transfer mechanism using the receiver command in bulkstats configuration mode.
  2. Specify the directory on the local SmartEdge router in which collected data is stored using the localdir command in bulkstats configuration mode.
  3. Specify the name and location of the collection files using the remotefile command in bulkstats configuration mode.

You must also:

You can enable collection for a bulkstats policy anytime after you have performed these tasks. You do not have to disable collection before you apply the policy to an entity, such as a port, channel, or circuit.

1.4   Configuring Bulkstats Policies

1.4.1   Create or Modify a Bulkstats Policy

To create or modify a bulkstats policy, perform the tasks described in Table 1.

Table 1    Create or Modify a Bulkstats Policy

#

Task

Root Command

Notes

1.

Create a bulkstats policy, or select one for modification, and access bulkstats configuration mode.

bulkstats policy

Enter this command in context configuration mode.

2.

Specify operational attributes; enter all commands in bulkstats configuration mode, unless otherwise noted.

   
 

Specify where the bulkstats data is stored for this policy on the SmartEdge router.

localdir

 
 

Set a limit on the space that is used to store bulkstats collection files.

limit

The default value is 1,024 KB. The range is up to 100 MB.

 

Specify the servers where remote bulkstats files are stored.

receiver

Enter this command twice to specify both a primary and a secondary bulkstats file server.

 

Specify the format of the filename and the location of the bulkstats collection files that are stored on remote servers.

remotefile

 
 

Specify header lines that are inserted at the beginning of each bulkstats collection file for this policy.

header format

 
 

Enable the writing of the definitions of the configured bulkstats schema profiles to the beginning of each bulkstats data collection file.

schema-dump

 
 

Specify the interval between the collection of bulk statistics samples.

sample-interval

The polling interval is between 1 and 525, 000 minutes (1 year); the default value is 15 minutes.

 

Specify the interval after which bulkstats data is uploaded to the bulkstats file server for this policy.

transfer-interval

The transfer interval is between 1 and 525, 000 minutes (1 year); The default value is 60 minutes.

3.

Enable the collection of bulkstats for all the entities to which this bulkstats policy will be applied.

collection

 

1.5   Create or Modify a Bulkstats Schema Profile

To create or modify a bulkstats schema profile, perform the task described in Table 2.

Table 2    Create or Modify a Bulkstats Schema Profile

Task

Root Command

Notes

Create or modify a bulkstats schema profile.

bulkstats schema profile

Enter this command in global configuration mode.

1.5.1   Apply a Specific Bulkstats Schema Profile

To apply a specific bulkstats schema profile, perform one of the tasks described in Table 3, depending on the type of schema profile.

Table 3    Apply a Specific Bulkstats Schema Profile

Task

Root Command

Notes

Apply a global bulkstats schema profile for system-level data collection.

schema

Enter this command in bulkstats configuration mode.

Apply an existing schema profile and bulkstats policy in the specified context to the context, port, link group, channel, or channel group; to a profile for an ATM PVC, Frame Relay PVC, or an 802.1Q PVC; or to a default subscriber profile.

bulkstats schema

Enter this command in the configuration mode for the entity.

1.6   Displaying Bulkstats Configuration

Table 4 shows the tasks for bulk statistics (bulkstats) operations. Enter the show commands in any mode; enter all other commands in exec mode.

Table 4    Bulkstats Operations Tasks

Task

Root Command

Immediately transfer bulkstats data for a specific bulkstats policy to one of the configured receivers, rather than waiting for the next transfer interval.

bulkstats force transfer

Display the bulk statistics (bulkstats) configuration information and data transfer statistics, or the contents of the current collection file that have not yet been successfully transferred to the receiver, for the specified bulkstats policy.

show bulkstats

2   Examples

See the following examples of configuring Bulkstats.

2.1   Examples: Create or Modify a Bulkstats Policy

The following example specifies the IP address of the primary file server that receives the uploaded bulkstats data files for the bulk policy:

[local]Redback(config)#context local
[local]Redback(config-ctx)#bulkstats policy bulk
[local]Redback(config-bulkstats)#receiver 198.168.145.99 primary mechanism
 ftp login snmp password snmp

The following example specifies the local directory on the SmartEdge router for the bulk policy, the amount of local file space allocated to bulk statistics storage in KB, and the filename format on the remote host. The filename format ensures that the filenames for two different policies will always be different, even if their transfer dates and time coincide:

[local]Redback(config-bulkstats)#localdir /flash/bulkstat
[local]Redback(config-bulkstats)#limit 2048
[local]Redback(config-bulkstats)#remotefile format "Bulkstats/%s_%s_%s_%s"
 context, policy date timeofday

The following example defines the header lines in each bulkstats file for the bulk policy:

[local]Redback(config-bulkstats)#header format "Collection file from host %s,
 Context: %s, Policy: %s" hostname context policy
[local]Redback(config-bulkstats)#header format "Data collected on %s" date

The following example enables the sampling and collection of bulkstats data for the bulk policy:

[local]Redback(config)#context local
[local]Redback(config-ctx)#bulkstats policy bulk
[local]Redback(config-bulkstats)#collection

2.2   Specify the Primary File Server for a Bulkstats Policy

The following example specifies the IP address of the primary file server that receives the uploaded bulkstats data files for the bulk policy:

[local]Redback(config)#context local
[local]Redback(config-ctx)#bulkstats policy bulk
[local]Redback(config-bulkstats)#receiver 198.168.145.99 primary mechanism
 ftp login snmp password snmp

The following example specifies the local directory on the SmartEdge router for the bulk policy, the amount of local file space allocated to bulk statistics storage in KB, and the filename format on the remote host. The filename format ensures that the filenames for two different policies will always be different, even if their transfer dates and time coincide:

[local]Redback(config-bulkstats)#localdir /flash/bulkstat
[local]Redback(config-bulkstats)#limit 2048
[local]Redback(config-bulkstats)#remotefile format "Bulkstats/%s_%s_%s_%s"
 context, policy date timeofday

The following example enables the sampling and collection of bulkstats data for the bulk policy:

[local]Redback(config)#context local
[local]Redback(config-ctx)#bulkstats policy bulk
[local]Redback(config-bulkstats)#collection

2.3   Example: Create and Apply a Bulkstats Global Schema Profile

The data collected by bulkstats policies are defined by schemas. Use the bulkstats schema profile command to create schemas.

The following example creates the gbl-bulk global schema profile and applies it to the sys-bulk bulkstats policy:

[local]Redback(config)#bulkstats schema profile global gbl-bulk format 
"uptime: %u, date:%s, time:%s" sysuptime date timeofday

[local]Redback(config)#context local
[local]Redback(ctx-config)#bulkstats policy sys-bulk
[local]Redback(bulkstats-config)#schema gbl-bulk

2.4   Example: Apply a Bulkstats ATM Schema Profile

The following example creates an ATM schema profile that collects circuit statistics for each ATM PVC to which the ATM profile ubr-bulk is applied. The last line of the example shows how the bulkstats schema command applies the newly defined schema atm-ubr, to the bulkstats policy bulk:

[local]Redback(config)#bulkstats schema profile atm atm-ubr format "uptime:
 %u, slot: %u, port: %u, vpi: %u, vci: %u, inoctets: %u outoctets: %u" 
sysuptime slot port vpi vci inoctets outoctets
[local]Redback(config)#atm profile ubr-bulk
[local]Redback(config-atm-profile)#shaping ubr
[local]Redback(config-atm-profile)#bulkstats schema atm-ubr policy bulk local

The following example configures an ATM PVC that references the ATM profile ubr-bulk on an ATM OC port:

[local]Redback(config)#port atm 4/1

[local]Redback(config-atm-oc)#atm pvc 16 233 profile ubr-bulk encapsulation 
route1483

[local]Redback(config-atm-pvc)#



The result of this schema is a line in the bulkstats collection file as follows:

[local]Redback(config-bulkstats)#
receiver 10.192.10.1 primary mechanism  ftp login user1 password password1
[local]Redback(config-bulkstats)#
receiver 10.192.10.2 secondary mechanism  ftp login user1 password password1
[local]Redback(config-bulkstats)#schema GLOBAL_SCHEMA
[local]Redback(config-bulkstats)#collection
[local]Redback(config)#port ethernet 2/1
[local]Redback(config-port)#bulkstats schema PORT_SCHEMA policy  15MIN_COLLECTION local

The following shows output of one sample in the file ./tmp/bulkstats/se800lab1_ 20080506_165931:

GLOBAL_SCHEMA: time: 1210117951, freemem: 211372, cpu5min: 0.00%, load5min: 
1.51, pppoe-sub-count: 1

PORT_SCHEMA: 1210117951, 12, 8, 66573057, 252156889, 675980, 894831, 3895582, 
4554