RFC 2594
Definitions of Managed Objects for WWW Services
RFC 2594: Definitions of Managed Objects for WWW Services 🎀
okay bestie, this one is a Standards Track doc from the Network Working Group, dated May 1999. the authors are H. Hazewinkel from the Joint Research Centre of the E.C., C. Kalbfleisch from Verio, Inc., and J. Schoenwaelder from TU Braunschweig 🧚. it doesn't list any RFCs it obsoletes or updates, so it's standing on its own 💅
Status of This Memo ✨
this doc is an Internet standards track protocol for the Internet community, and it's asking everyone for discussion and suggestions for improvements 🫶 for the current standardization state and status of this protocol, check the current edition of the "Internet Official Protocol Standards" (STD 1). distribution of this memo is unlimited 🌸
Copyright Notice 💜
Copyright (C) The Internet Society (1999). All Rights Reserved.
Abstract 🦋
this memo defines a chunk of the Management Information Base (MIB) for network management protocols in the Internet Community. specifically, it's a set of objects for managing World Wide Web (WWW) services. it's giving organized 🍓
Table of Contents 📋
1 Introduction ................................................. 1
2 The SNMP Management Framework ................................ 2
3 Terminology .................................................. 3
4 Overview ..................................................... 4
4.1 Purpose and Requirements ................................... 4
4.2 Relationship to other Standards Efforts .................... 5
4.3 WWW Services ............................................... 5
4.4 Document Transfer Protocol ................................. 6
5 Structure of the MIB ......................................... 7
5.1 Service Information Group .................................. 7
5.2 Protocol Statistics Group .................................. 7
5.3 Document Statistics Group .................................. 8
6 Definitions .................................................. 10
7 Document Transfer Protocol Mappings .......................... 36
7.1 The HyperText Transfer Protocol ............................ 36
7.2 The File Transfer Protocol ................................. 37
8 Security Considerations ...................................... 38
9 Intellectual Property ........................................ 39
10 Acknowledgments ............................................. 39
11 Editors' Addresses .......................................... 39
12 References .................................................. 40
13 Full Copyright Statement .................................... 431. Introduction ✨
okay so this memo defines a set of objects for managing World Wide Web (WWW) services 🕸️ it extends the application management framework from the System Application Management MIB (SYSAPPL-MIB) [23] and the Application Management MIB (APPLICATION-MIB) [24]. but it's also self-contained, so you can implement and use it without having to implement or install the APPLICATION-MIB or the SYSAPPL-MIB. main character energy 👑
the protocol statistics in the WWW Service MIB are based on an abstract document transfer protocol (DTP). this memo also defines a mapping of the abstract DTP to HTTP and FTP. more mappings might be defined later so this MIB can be used with other document transfer protocols, and those future mappings are expected to live in separate RFCs 🦋
the key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119 [17]. 🫶
2. The SNMP Management Framework 🧩
the SNMP Management Framework currently has five major components, and they're all giving teamwork:
- An overall architecture, described in RFC 2571 [1].
- Mechanisms for describing and naming objects and events for the purpose of management. The first version of this Structure of Management Information (SMI) is called SMIv1 and is described in STD 16, RFC 1155 [2], STD 16, RFC 1212 [3] and RFC 1215 [4]. The second version, called SMIv2, is described in STD 58, RFC 2578 [5], RFC 2579 [6] and RFC 2580 [7].
- Message protocols for transferring management information. The first version of the SNMP message protocol is called SNMPv1 and is described in STD 15, RFC 1157 [8]. A second version of the SNMP message protocol, which is not an Internet standards track protocol, is called SNMPv2c and is described in RFC 1901 [9] and RFC 1906 [10]. The third version of the message protocol is called SNMPv3 and is described in RFC 1906 [10], RFC 2572 [11] and RFC 2574 [12].
- Protocol operations for accessing management information. The first set of protocol operations and associated PDU formats is described in RFC 1157 [8]. A second set of protocol operations and associated PDU formats is described in RFC 1905 [13].
- A set of fundamental applications described in RFC 2573 [14] and the view-based access control mechanism described in RFC 2575 [15].
managed objects get accessed through a virtual information store called the Management Information Base or MIB 🗂️ objects in the MIB are defined using the mechanisms defined in the SMI.
this memo specifies a MIB module that is compliant to the SMIv2. a MIB conforming to the SMIv1 can be produced through the appropriate translations. the resulting translated MIB must be semantically equivalent, except where objects or events are omitted because no translation is possible (use of Counter64). some machine readable information in SMIv2 will be converted into textual descriptions in SMIv1 during the translation process. however, losing that machine readable information is not considered to change the semantics of the MIB 🤓
3. Terminology 📖
this section defines the terminology used throughout this document, so let's get the vocab down:
- A 'World Wide Web' (WWW) is a world wide information system which is based on the concept of documents that are linked together by embedding references (links) to other local or remote documents.
- A 'document' is a coherent piece of data which is accessible in the World Wide Web. No assumptions are made about the content or the type of a document.
- A 'Uniform Resource Locator' (URL) is a formatted string representation for a document available via the Internet. URLs are used to express references between documents. For the syntax and semantics of the URL string representation refer to RFC 2396 [18]
- A 'Document Transfer Protocol' (DTP) is a protocol used within the World Wide Web to invoke actions on documents. The DTP is an abstraction from real protocols, such as HTTP [19,20] or FTP [21].
- A 'request' is a DTP protocol operation which is targeted to a 'document' and invokes an action on the target document. The request type specifies the action that should be performed. A request can have a document associated with it.
- A 'response' is a DTP protocol operation which is returned as a result of a previous (and associated) request. The response status indicates if the requested action was successful or if errors occurred. A response can have a document associated with it.
- A 'WWW service' is a set of actions that can be invoked on a document. Typical actions are the transfer of documents or the retrieval of administrative information about documents. WWW services are provided by means of a DTP. A WWW service can be identified by the DTP protocol used to invoke services and the transport endpoint used by that protocol.
- A 'client' is a program which establishes connections for the purpose of sending requests and receiving responses.
- A 'server' is a program that accepts connections in order to service requests by sending back responses.
- A 'proxy' is an intermediary program which acts as both a server and a client for the purpose of making requests on behalf of other clients. Requests are serviced internally or by passing them on, with possible translation, to other servers.
- A 'caching proxy' is a proxy with the capability of locally storing responses to associated requests. A caching proxy can respond to similar requests with a previously stored response.
4. Overview 🌈
the World Wide Web (WWW) is a global network of information 🌍 information lives in documents, which can have various formats, including hyper-text and multi-media documents. you get access to these documents through servers located all around the world, which are linked to each other via hyper-links embedded in documents.
the usability of the World Wide Web depends largely on the performance of the services these servers realize. the services are typically monitored through log files, and that gets really hard when a single organization is responsible for a large number of services 😭 so it's desirable to treat WWW services as objects that can be managed by using the Internet network management framework [22].
4.1. Purpose and Requirements 🎯
the goal of this MIB is to define a standardized set of objects which lead to integrated and improved performance and fault management in a heterogeneous environment of WWW services. this MIB focuses on the service-oriented view. it does not deal with the process oriented view, which is covered by the System Application MIB [23] and the Application MIB [24].
this document defines a set of managed objects to monitor WWW services for short-term operational purposes, such as problem detection and troubleshooting. no attempts are made here to cover accounting or hit metering issues 🙅♀️
the scope of the MIB is further limited by the requirement that an implementation conforming to this MIB must be possible without putting a huge CPU or memory burden on the WWW server implementation. 💪
in addition, this MIB does not cover WWW service configuration. server software has become an open market where competing vendors constantly invent new features in order to shape their products. so it's not possible to reach consensus on a common way to configure WWW services at this point in time 🥲
4.2. Relationship to other Standards Efforts 🦋
okay so the WWW Service MIB fits into the application management architecture from the System Application MIB [23] 💅. The System Application MIB and the Application MIB [24] both use a process-oriented view, where an application is basically a collection of processes. This memo's WWW Service MIB is different. It uses a service-oriented view, which looks at the services a set of processes provides ✨.
the process view and the service view have a many-to-many relationship, and that's the iconic part 👑. one process can implement multiple services, and multiple services can come from one single set of processes. the Application Management MIB [24] has generic mapping tables that translate back and forth between the two views 🫶.
the WWW Service MIB hooks into the Application MIB [24] by using the service instance identifier (applSrvIndex) as wwwServiceIndex, but only if a matching instance of applSrvIndex actually exists 🌸. and if the service-level tables in the Application MIB aren't available, no worries, the WWW Service MIB is self-contained and can run as a stand-alone module 🧚.
4.3. WWW Services 🍓
the MIB is built around WWW services. a WWW service is a set of actions that can be invoked on a document 📄. a WWW service is provided or used by a client, a server or a proxy. clients send out requests for information to a server or a proxy server. servers receive, process and respond to requests from clients. servers usually have access to local documents, which can be transferred to clients 💜.
a proxy is a special kind of server, and it acts as both a server and a client, because it makes requests on behalf of other clients 🎀. a proxy can translate between the client and the origin server. a proxy might also talk to other information retrieval systems, like databases, for example 🌈.
the MIB defined in this memo tells apart outgoing and incoming requests and responses. that's the magic, because it means you can get statistics for clients, servers and proxies with one single set of objects 🔥.
a special proxy server is the caching proxy 💖. it keeps a cache of previously received documents so it can reduce the bandwidth used by World Wide Web clients. one really useful bit of management info is the percentage of requests that got served from the caching proxy's cache (hits/miss-ratio) 👀. this ratio is not explicitly in this MIB, but you can derive it from the objects that count incoming and outgoing requests and responses, so it's not missing, it's just a little math away 🧮.
4.4. Document Transfer Protocol ✨
the MIB is based on an abstract document transfer protocol (DTP) 🧠. the whole point of the DTP is to keep the MIB definitions independent from concrete protocols, like the Hypertext Transfer Protocol (HTTP) [19,20] or the File Transfer Protocol (FTP) [21]. no protocol drama in the MIB itself 💅.
the abstract document transfer protocol makes these assumptions about a concrete transfer protocol:
- The transfer protocol uses a request/response style of interactions.
- Every request contains a request type, which defines the operations performed by the receiving server. The request type is represented by an OCTET STRING. It might be necessary to define a translation into an OCTET STRING value for protocols that use numbers to identify request types.
- A response contains a status code, which indicates if the request was processed successfully or which error occurred. The status code is represented as an INTEGER value. It might be necessary to define a mapping for protocols that do not use an INTEGER status code.
- A transfer protocol can send multiple responses for a single request. Multiple responses are counted separately in the protocol statistics group.
A primary response has to be identified for the document statistics. The primary response is the response that indicates whether the request was successful 🎯.
Section 7 of this memo defines a mapping of the document transfer protocol to the HTTP protocol and the FTP protocol 🗺️. mappings to other protocols, like NNTP [25] or WebNFS [26,27], might be defined in the future 🔮.
5. Structure of the MIB 🏗️
this section shows you how the MIB is put together. the objects are arranged into these groups:
- service information
- protocol statistics
- document statistics
5.1. Service Information Group 📋
the service information group is a single table describing all the WWW services managed by the SNMP agent. the service table holds administrative network management info for (potentially) multiple WWW services running on a single host. it also has info for all services within virtual domains of a host 🏠. the columns in the table split into two main groups:
- global administrative information of the service, such as service contact person, and
- network information, such as the transfer protocol.
5.2. Protocol Statistics Group 📊
the protocol statistics group gives network management info about the traffic received or transmitted by a WWW service. this group has counters related to DTP protocol operations, and it consists of five tables:
- The wwwSummaryTable contains a set of network traffic related counters. It summarizes the network traffic and protocol operations related to a WWW service. It's well recognized that some variables are redundant with respect to the request and response tables, but they're added so an operator gets a quick overview and SNMP network traffic gets reduced 🙈.
- The wwwRequestInTable contains detailed information about incoming requests. Every particular request type is counted separately.
- The wwwRequestOutTable contains detailed information about outgoing requests. Every particular request type is counted separately.
- The wwwResponseInTable contains detailed information about incoming responses. Every particular response type is counted separately.
- The wwwResponseOutTable contains detailed information about outgoing responses. Every particular response type is counted separately.
5.3. Document Statistics Group 📚
the document group holds info about the documents that were accessed in the past 🕰️. the group gives four types of statistics:
- Details about the last N attempts to invoke actions on documents.
- The Top N documents sorted by the number of actions invoked on them, computed over a time interval.
- The Top N documents sorted by the number of content bytes transferred, computed over a time interval.
- Summary statistics computed over a time interval.
the Top N document statistics get collected in buckets. this keeps agent resources in check and lets a manager spot changes in the service usage pattern 👀. buckets fill up over a configurable time interval. the agent computes the Top N statistics and starts a new bucket once the bucket's time interval has passed. the time interval is configurable for each WWW service ⏰.
the document statistics group links a response type to the request that invoked an action. if a DTP sends multiple responses, the primary response must be used to derive the response type of the request/response interaction 🎯.
the group consists of the following tables:
- The wwwDocCtrlTable gives the manager a way to limit the size of the document statistic tables and to control the expiration and creation of buckets 🎛️.
- The wwwDocLastNTable gives the manager info about the last N documents which were accessed. The table lists the documents for which access was attempted, along with the request and response type of the DTP and a status message. The request and response types tell a manager how attempts to invoke actions were handled by the DTP. The status message object gives human readable text to further describe the response type 💬.
The number of documents in the wwwDocLastNTable is controlled by the wwwDocCtrlLastNSize object in the wwwDocCtrlTable. The wwwDocCtrlLastNLock object of the wwwDocCtrlTable lets a management application lock the wwwDocLastNTable, so it can grab a consistent snapshot of the fast changing wwwDocLastNTable 📸.
- The wwwDocBucketTable lists the buckets of statistical information that have been collected. An entry in the wwwDocBucketTable contains the creation timestamp of the bucket, plus summary information (number of accesses, number of documents accessed and number of bytes transferred) 🪣.
The time interval is controlled by the wwwDocCtrlBucketTimeInterval object of the wwwDocCtrlTable. The maximum number of buckets the SNMP agent keeps for a particular WWW service is controlled by the wwwDocCtrlBuckets object of the wwwDocCtrlTable.
- The wwwDocAccessTopNTable gives the manager an overview of the top N documents which were accessed while statistics were collected for a particular bucket. The wwwDocAccessTopNTable is sorted by the number of read attempts per document. The maximum number of entries in the wwwDocAccessTopNTable is controlled by the wwwDocCtrlTopNSize object 🏆.
- The wwwDocBytesTopNTable gives the manager an overview of the top N documents which caused most of the network traffic while statistics were collected for a particular bucket. The wwwDocBytesTopNTable is sorted by the number of bytes transferred. The maximum number of entries in the wwwDocBytesTopNTable is controlled by the wwwDocCtrlTopNSize object 💾.
The Top N statistics and the parameters of the underlying bucket are not visible in the MIB as long as the bucket is still filling up. instead, these steps must be taken when a bucket's time interval has passed:
- A new entry in the wwwDocBucketTable is created to summarize the document statistics for that time interval.
- The corresponding entries in the wwwDocAccessTopNTable and the wwwDocBytesTopNTable are computed and made available.
- If the resulting number of entries in the wwwDocBucketTable for the WWW service now exceeds wwwDocCtrlBuckets, then the oldest bucket for this WWW service and all corresponding entries in the wwwDocBucketTable, wwwDocAccessTopNTable, and wwwDocBytesTopNTable are deleted 🗑️.
a bucket usually holds way more data than what shows up in the Top N tables 🤯. the number of entries in the Top N table for a bucket is controlled by wwwDocCtrlTopNSize, but the number of entries in a bucket depends on how many actions were invoked on documents during the time interval that the bucket fills up over. so it is suggested to discard the data associated with a bucket once the entries for the wwwDocBucketTable, wwwDocAccessTopNTable and wwwDocBytesTopNTable have been calculated 🧹.
6. Definitions 📜
WWW-MIB DEFINITIONS ::= BEGIN
IMPORTS
MODULE-IDENTITY, OBJECT-TYPE, mib-2,
Counter32, Counter64, Integer32, Unsigned32, TimeTicks
FROM SNMPv2-SMIokay so this next chunk is where the MIB really starts coming together, bestie 🎀✨ we've got the imports, the module identity with all three editors (Harrie, Carl, and Juergen 🫶), and the textual conventions that the whole thing is built on 💅
the module identity is giving 🌈
TEXTUAL-CONVENTION, DisplayString, DateAndTime, TimeInterval
FROM SNMPv2-TC
MODULE-COMPLIANCE, OBJECT-GROUP
FROM SNMPv2-CONF
Utf8String
FROM SYSAPPL-MIB;
wwwMIB MODULE-IDENTITY
LAST-UPDATED "9902251400Z"
ORGANIZATION "IETF Application MIB Working Group"
CONTACT-INFO
" Harrie Hazewinkel
Postal: Joint Research Centre of the E.C.
via Fermi - Ispra 21020 (VA)
Italy
Tel: +39+(0)332 786322
Fax: +39+(0)332 785641
E-mail: harrie.hazewinkel@jrc.it
Carl W. Kalbfleisch
Postal: Verio, Inc.
1950 Stemmons Freeway
Suite 2006
Dallas, TX 75207
US
Tel: +1 214 290-8653
Fax: +1 214 744-0742
E-mail: cwk@verio.net
Juergen Schoenwaelder
Postal: TU Braunschweig
Bueltenweg 74/75
38106 Braunschweig
Germany
Tel: +49 531 391-3683
Fax: +49 531 489-5936
E-mail: schoenw@ibr.cs.tu-bs.de"
DESCRIPTION
"This WWW service MIB module is applicable to services
realized by a family of 'Document Transfer Protocols'
(DTP). Examples of DTPs are HTTP and FTP."
-- revision history
REVISION "9902251400Z"
DESCRIPTION "Initial version, published as RFC2594."
::= { mib-2 65 }
--
-- Object Identifier Assignments
--
wwwMIBObjects OBJECT IDENTIFIER ::= { wwwMIB 1 }
wwwMIBConformance OBJECT IDENTIFIER ::= { wwwMIB 2 }
--
-- Textual Conventions
--
WwwRequestType ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"The WwwRequestType defines the textual identification of
request types used by a document transfer protocol. For
the proper values for a given DTP, refer to the protocol
mappings for that DTP."
SYNTAX OCTET STRING (SIZE (1..40))
WwwResponseType ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"The WwwResponseType defines the different response values
used by document transfer protocols. For the proper values
for a given DTP, refer to the protocol mappings for that
DTP."
SYNTAX Integer32 (0..2147483647)
WwwOperStatus ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"The operational status of a WWW service. 'down' indicates
that the service is not available. 'running' indicates
that the service is operational and available. 'halted'
indicates that the service is operational but not
available. 'congested' indicates that the service is
operational but no additional inbound associations can be
accommodated. 'restarting' indicates that the service is
currently unavailable but is in the process of restarting
and will be available soon."
SYNTAX INTEGER {
down(1),
running(2),
halted(3),
congested(4),
restarting(5)
}
WwwDocName ::= TEXTUAL-CONVENTION
DISPLAY-HINT "255a"
STATUS current
DESCRIPTION
"The server relative name of a document. If the URL were
http://www.x.org/standards/search/search.cgi?string=test
then the value of this textual convention would resolve
to '/standards/search/search.cgi'. This textual convention
uses the character set for URIs as defined in RFC 2396
section 2."
SYNTAX OCTET STRING (SIZE (0..255))now the service information group 🧚 this is where each WWW service gets its own little profile card, and the table is indexed so you can find it 🔍
-- The WWW Service Information Group
--
-- The WWW service information group contains information about
-- the WWW services known by the SNMP agent.
wwwService OBJECT IDENTIFIER ::= { wwwMIBObjects 1 }
wwwServiceTable OBJECT-TYPE
SYNTAX SEQUENCE OF WwwServiceEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The table of the WWW services known by the SNMP agent."
::= { wwwService 1 }
wwwServiceEntry OBJECT-TYPE
SYNTAX WwwServiceEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"Details about a particular WWW service."
INDEX { wwwServiceIndex }
::= { wwwServiceTable 1 }
WwwServiceEntry ::= SEQUENCE {
wwwServiceIndex Unsigned32,
wwwServiceDescription Utf8String,
wwwServiceContact Utf8String,
wwwServiceProtocol OBJECT IDENTIFIER,
wwwServiceName DisplayString,
wwwServiceType INTEGER,
wwwServiceStartTime DateAndTime,
wwwServiceOperStatus WwwOperStatus,
wwwServiceLastChange DateAndTime
}
wwwServiceIndex OBJECT-TYPE
SYNTAX Unsigned32 (1..4294967295)
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"An integer used to uniquely identify a WWW service. The
value must be the same as the corresponding value of the
applSrvIndex defined in the Application Management MIB
(APPLICATION-MIB) if the applSrvIndex object is available.
It might be necessary to manually configure sub-agents in
order to meet this requirement."
::= { wwwServiceEntry 1 }
wwwServiceDescription OBJECT-TYPE
SYNTAX Utf8String
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Textual description of the WWW service. This shall include
at least the vendor and version number of the application
realizing the WWW service. In a minimal case, this might
be the Product Token (see RFC 2068) for the application."
::= { wwwServiceEntry 2 }
wwwServiceContact OBJECT-TYPE
SYNTAX Utf8String
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The textual identification of the contact person for this
service, together with information on how to contact this
person. For instance, this might be a string containing an
email address, e.g. '<webmaster@domain.name>'."
::= { wwwServiceEntry 3 }
wwwServiceProtocol OBJECT-TYPE
SYNTAX OBJECT IDENTIFIER
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"An identification of the primary protocol in use by this
service. For Internet applications, the IANA maintains
a registry of the OIDs which correspond to well-known
application protocols. If the application protocol is not
listed in the registry, an OID value of the form
{applTCPProtoID port} or {applUDPProtoID port} are used for
TCP-based and UDP-based protocols, respectively. In either
case 'port' corresponds to the primary port number being
used by the protocol."
REFERENCE
"The OID values applTCPProtoID and applUDPProtoID are
defined in the NETWORK-SERVICES-MIB (RFC 2248)."
::= { wwwServiceEntry 4 }
wwwServiceName OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The fully qualified domain name by which this service is
known. This object must contain the virtual host name if
the service is realized for a virtual host."
::= { wwwServiceEntry 5 }
wwwServiceType OBJECT-TYPE
SYNTAX INTEGER {
wwwOther(1),
wwwServer(2),
wwwClient(3),
wwwProxy(4),
wwwCachingProxy(5)
}
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The application type using or realizing this WWW service."
::= { wwwServiceEntry 6 }
wwwServiceStartTime OBJECT-TYPE
SYNTAX DateAndTime
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The date and time when this WWW service was last started.
The value SHALL be '0000000000000000'H if the last start
time of this WWW service is not known."
::= { wwwServiceEntry 7 }
wwwServiceOperStatus OBJECT-TYPE
SYNTAX WwwOperStatus
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Indicates the operational status of the WWW service."
::= { wwwServiceEntry 8 }
wwwServiceLastChange OBJECT-TYPE
SYNTAX DateAndTime
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The date and time when this WWW service entered its current
operational state. The value SHALL be '0000000000000000'H if
the time of the last state change is not known."
::= { wwwServiceEntry 9 }and now the protocol statistics group 📊 this part counts every request and response going in and out, and it's giving very "keeping receipts" energy 🧾💅
-- The WWW Protocol Statistics Group
--
-- The WWW protocol statistics group contains statistics about
-- the DTP requests and responses sent or received.
wwwProtocolStatistics OBJECT IDENTIFIER ::= { wwwMIBObjects 2 }
wwwSummaryTable OBJECT-TYPE
SYNTAX SEQUENCE OF WwwSummaryEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The table providing overview statistics for the
WWW services on this system."
::= { wwwProtocolStatistics 1 }
wwwSummaryEntry OBJECT-TYPE
SYNTAX WwwSummaryEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"Overview statistics for an individual service."
INDEX { wwwServiceIndex }
::= { wwwSummaryTable 1 }
WwwSummaryEntry ::= SEQUENCE {
wwwSummaryInRequests Counter32,
wwwSummaryOutRequests Counter32,
wwwSummaryInResponses Counter32,
wwwSummaryOutResponses Counter32,
wwwSummaryInBytes Counter64,
wwwSummaryInLowBytes Counter32,
wwwSummaryOutBytes Counter64,
wwwSummaryOutLowBytes Counter32
}
wwwSummaryInRequests OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of requests successfully received."
::= { wwwSummaryEntry 1 }
wwwSummaryOutRequests OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of requests generated."
::= { wwwSummaryEntry 2 }
wwwSummaryInResponses OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of responses successfully received."
::= { wwwSummaryEntry 3 }
wwwSummaryOutResponses OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of responses generated."
::= { wwwSummaryEntry 4 }
wwwSummaryInBytes OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of content bytes received."
::= { wwwSummaryEntry 5 }
wwwSummaryInLowBytes OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The lowest thirty-two bits of wwwSummaryInBytes."
::= { wwwSummaryEntry 6 } wwwSummaryOutBytes OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of content bytes transmitted."
::= { wwwSummaryEntry 7 }
wwwSummaryOutLowBytes OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The lowest thirty-two bits of wwwSummaryOutBytes."
::= { wwwSummaryEntry 8 }
-- The WWW request tables contain detailed information about
-- requests send or received by WWW services.
wwwRequestInTable OBJECT-TYPE
SYNTAX SEQUENCE OF WwwRequestInEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The table providing detailed statistics for requests
received by WWW services on this system."
::= { wwwProtocolStatistics 2 }
wwwRequestInEntry OBJECT-TYPE
SYNTAX WwwRequestInEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"Request statistics for an individual service."
INDEX { wwwServiceIndex, wwwRequestInIndex }
::= { wwwRequestInTable 1 }
WwwRequestInEntry ::= SEQUENCE {
wwwRequestInIndex WwwRequestType,
wwwRequestInRequests Counter32,
wwwRequestInBytes Counter32,
wwwRequestInLastTime DateAndTime
}
wwwRequestInIndex OBJECT-TYPE
SYNTAX WwwRequestType
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The particular request type the statistics apply to."
::= { wwwRequestInEntry 1 }
wwwRequestInRequests OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of requests of this type received by this
WWW service."
::= { wwwRequestInEntry 2 }
wwwRequestInBytes OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of content bytes per request type received
by this WWW service."
::= { wwwRequestInEntry 3 }
wwwRequestInLastTime OBJECT-TYPE
SYNTAX DateAndTime
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The date and time when the last byte of the last complete
request of this type was received by this WWW service. The
value SHALL be '0000000000000000'H if no request of this
type has been received yet."
::= { wwwRequestInEntry 4 }
wwwRequestOutTable OBJECT-TYPE
SYNTAX SEQUENCE OF WwwRequestOutEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The table providing detailed statistics for requests
generated by the services on this system."
::= { wwwProtocolStatistics 3 }
wwwRequestOutEntry OBJECT-TYPE
SYNTAX WwwRequestOutEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"Request statistics for an individual service."
INDEX { wwwServiceIndex, wwwRequestOutIndex }
::= { wwwRequestOutTable 1 }
WwwRequestOutEntry ::= SEQUENCE {
wwwRequestOutIndex WwwRequestType,
wwwRequestOutRequests Counter32,
wwwRequestOutBytes Counter32,
wwwRequestOutLastTime DateAndTime
}
wwwRequestOutIndex OBJECT-TYPE
SYNTAX WwwRequestType
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The particular request type the statistics apply to."
::= { wwwRequestOutEntry 1 }
wwwRequestOutRequests OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of requests of this type generated by this
WWW service."
::= { wwwRequestOutEntry 2 }
wwwRequestOutBytes OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of content bytes per requests type generated
by this WWW service."
::= { wwwRequestOutEntry 3 }
wwwRequestOutLastTime OBJECT-TYPE
SYNTAX DateAndTime
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The date and time when the first byte of the last request
of this type was send by this WWW service. The value SHALL
be '0000000000000000'H if no request of this type has been
send yet."
::= { wwwRequestOutEntry 4 }okay the request tables are giving detailed stats bestie 📨✨ The next bit is all about responses, so let's keep going 💅
-- The WWW response tables contain detailed information about
-- responses sent or received by WWW services.
wwwResponseInTable OBJECT-TYPE
SYNTAX SEQUENCE OF WwwResponseInEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The table providing detailed statistics for responses
received by WWW services on this system."
::= { wwwProtocolStatistics 4 }
wwwResponseInEntry OBJECT-TYPE
SYNTAX WwwResponseInEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"Response statistics for an individual service."
INDEX { wwwServiceIndex, wwwResponseInIndex }
::= { wwwResponseInTable 1 }
WwwResponseInEntry ::= SEQUENCE {
wwwResponseInIndex WwwResponseType,
wwwResponseInResponses Counter32,
wwwResponseInBytes Counter32,
wwwResponseInLastTime DateAndTime
}
wwwResponseInIndex OBJECT-TYPE
SYNTAX WwwResponseType
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The particular response type the statistics apply to."
::= { wwwResponseInEntry 1 }
wwwResponseInResponses OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of responses of this type received by this
WWW service."
::= { wwwResponseInEntry 2 }
wwwResponseInBytes OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of content bytes per response type received
by this WWW service."
::= { wwwResponseInEntry 3 }
wwwResponseInLastTime OBJECT-TYPE
SYNTAX DateAndTime
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The date and time when the last byte of the last complete
response of this type was received by this WWW service. The
value SHALL be '0000000000000000'H if no response of this
type has been received yet."
::= { wwwResponseInEntry 4 }
wwwResponseOutTable OBJECT-TYPE
SYNTAX SEQUENCE OF WwwResponseOutEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The table providing detailed statistics for responses
generated by services on this system."
::= { wwwProtocolStatistics 5 }
wwwResponseOutEntry OBJECT-TYPE
SYNTAX WwwResponseOutEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"Response statistics for an individual service."
INDEX { wwwServiceIndex, wwwResponseOutIndex }
::= { wwwResponseOutTable 1 }
WwwResponseOutEntry ::= SEQUENCE {
wwwResponseOutIndex WwwResponseType,
wwwResponseOutResponses Counter32,
wwwResponseOutBytes Counter32,
wwwResponseOutLastTime DateAndTime
}
wwwResponseOutIndex OBJECT-TYPE
SYNTAX WwwResponseType
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The particular response type the statistics apply to."
::= { wwwResponseOutEntry 1 }
wwwResponseOutResponses OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of responses of this type generated by this
WWW service."
::= { wwwResponseOutEntry 2 }
wwwResponseOutBytes OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of content bytes per response type generated
by this WWW service."
::= { wwwResponseOutEntry 3 }
wwwResponseOutLastTime OBJECT-TYPE
SYNTAX DateAndTime
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The date and time when the first byte of the last response of
this type was sent by this WWW service. The value SHALL be
'0000000000000000'H if response of this type has been send
yet."
::= { wwwResponseOutEntry 4 }
-- The WWW Document Statistics Group
--
-- The WWW document statistics group contains statistics about
-- document read attempts.
wwwDocumentStatistics OBJECT IDENTIFIER ::= { wwwMIBObjects 3 }
wwwDocCtrlTable OBJECT-TYPE
SYNTAX SEQUENCE OF WwwDocCtrlEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A table which controls how the MIB implementation
collects and maintains document statistics."
::= { wwwDocumentStatistics 1 }
wwwDocCtrlEntry OBJECT-TYPE
SYNTAX WwwDocCtrlEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"An entry used to configure the wwwDocLastNTable,
the wwwDocBucketTable, the wwwDocAccessTopNTable,
and the wwwDocBytesTopNTable."
INDEX { wwwServiceIndex }
::= { wwwDocCtrlTable 1 }
WwwDocCtrlEntry ::= SEQUENCE {
wwwDocCtrlLastNSize Unsigned32,
wwwDocCtrlLastNLock TimeTicks,
wwwDocCtrlBuckets Unsigned32,
wwwDocCtrlBucketTimeInterval TimeInterval,
wwwDocCtrlTopNSize Unsigned32
}
wwwDocCtrlLastNSize OBJECT-TYPE
SYNTAX Unsigned32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The maximum number of entries in the wwwDocLastNTable."
DEFVAL { 25 }
::= { wwwDocCtrlEntry 1 }
wwwDocCtrlLastNLock OBJECT-TYPE
SYNTAX TimeTicks
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"This object allows a manager to lock the wwwDocLastNTable
in order to retrieve the wwwDocLastNTable in a consistent
state. The agent is expected to take a snapshot of the
wwwDocLastNTable when it is locked and to continue updating
the real wwwDocLastNTable table so that recent information is
available as soon as the wwwDocLastNTable is unlocked again.
Setting this object to a value greater than 0 will lock
the table. The timer ticks backwards until it reaches 0.
The table unlocks automatically once the timer reaches 0
and the timer stops ticking.
A manager can increase the timer to request more time to
read the table. However, any attempt to decrease the timer
will fail with an inconsistentValue error. This rule ensures
that multiple managers can simultaneously lock and retrieve
the wwwDocLastNTable. Note that managers must cooperate in
using wwwDocCtrlLastNLock. In particular, a manager MUST not
keep the wwwDocLastNTable locked when it is not necessary to
finish a retrieval operation."
::= { wwwDocCtrlEntry 2 }that's the end of this chunk, we're still in the definitions 🧚💜
Okay bestie, this is where the stats really get cute 🎀✨ We're in the window-of-history territory now: the bucket settings, the last-N log, the top-N leaderboards. Let's go 💅
The first little batch is the control knobs. wwwDocCtrlBuckets decides how many buckets the agent keeps before the oldest one gets deleted 🗑️, and wwwDocCtrlBucketTimeInterval sets how long each bucket collects stuff. The defaults are giving math-class vibes 🤓
wwwDocCtrlBuckets OBJECT-TYPE
SYNTAX Unsigned32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The maximum number of buckets maintained by the agent
before the oldest bucket is deleted. The buckets are
used to populate the wwwDocAccessTopNTable and the
wwwDocBytesTopNTable. The time interval captured in
each bucket can be configured by setting the
wwwDocCtrlBucketTimeInterval object."
DEFVAL { 4 } -- 4 buckets times 15 minutes = 1 hour
::= { wwwDocCtrlEntry 3 }
wwwDocCtrlBucketTimeInterval OBJECT-TYPE
SYNTAX TimeInterval
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The time interval after which a new bucket is created.
Changing this object has no effect on existing buckets."
DEFVAL { 90000 } -- 15 minutes (resolution .01 s)
::= { wwwDocCtrlEntry 4 }
wwwDocCtrlTopNSize OBJECT-TYPE
SYNTAX Unsigned32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The maximum number of entries shown in the
wwwDocAccessTopNTable and the wwwDocBytesTopNTable.
Changing this object has no effect on existing buckets."
DEFVAL { 25 }
::= { wwwDocCtrlEntry 5 }Quick note on the timing: wwwDocCtrlBucketTimeInterval is in hundredths of a second, so 90000 is the 15 minutes, and the default bucket count of 4 gets you one hour total 🕐 Changing these only affects new buckets, so the old ones just keep chilling 🧊
Next up is the Last N table 📜. It's a sliding window of the most recent access attempts, and each row is one attempt with its name, timestamp, request type, response type, status message, and bytes.
wwwDocLastNTable OBJECT-TYPE
SYNTAX SEQUENCE OF WwwDocLastNEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The table which logs the last N access attempts."
::= { wwwDocumentStatistics 2 }
wwwDocLastNEntry OBJECT-TYPE
SYNTAX WwwDocLastNEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"An entry which describes a recent access attempt."
INDEX { wwwServiceIndex, wwwDocLastNIndex }
::= { wwwDocLastNTable 1 }
WwwDocLastNEntry ::= SEQUENCE {
wwwDocLastNIndex Unsigned32,
wwwDocLastNName WwwDocName,
wwwDocLastNTimeStamp DateAndTime,
wwwDocLastNRequestType WwwRequestType,
wwwDocLastNResponseType WwwResponseType,
wwwDocLastNStatusMsg Utf8String,
wwwDocLastNBytes Unsigned32
}
wwwDocLastNIndex OBJECT-TYPE
SYNTAX Unsigned32 (1..4294967295)
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"An arbitrary monotonically increasing integer number used
for indexing the wwwDocLastNTable. The first document
accessed appears in the table with this index value equal
to one. Each subsequent document is indexed with the next
sequential index value. The Nth document accessed will be
indexed by N. This table presents a sliding window of the
last wwwDocCtrlLastNSize documents accessed. Thus, entries
in this table will be indexed by N-wwwDocCtrlLastNSize
thru N if N > wwwDocCtrlLastNSize and 1 thru N if
N <= wwwDocCtrlLastNSize.
The wwwDocCtrlLastNLock attribute can be used to lock
this table to allow the manager to read its contents."
::= { wwwDocLastNEntry 1 }
wwwDocLastNName OBJECT-TYPE
SYNTAX WwwDocName
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The name of the document for which access was attempted."
::= { wwwDocLastNEntry 2 }
wwwDocLastNTimeStamp OBJECT-TYPE
SYNTAX DateAndTime
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The date and time of the last attempt to access this
document."
::= { wwwDocLastNEntry 3 }
wwwDocLastNRequestType OBJECT-TYPE
SYNTAX WwwRequestType
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The protocol request type which was received by the
server when this document access was attempted."
::= { wwwDocLastNEntry 4 }
wwwDocLastNResponseType OBJECT-TYPE
SYNTAX WwwResponseType
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The protocol response type which was sent to the client
as a result of this attempt to access a document. This
object contains the type of the primary response if
there were multiple responses to a single request."
::= { wwwDocLastNEntry 5 }
wwwDocLastNStatusMsg OBJECT-TYPE
SYNTAX Utf8String
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object contains a human readable description of the
reason why the wwwDocLastNResponseType was returned to the
client. This object defines the implementation-specific
reason if the value of wwwDocLastNResponseType indicates
an error. For example, this object can indicate that the
requested document could not be transferred due to a
timeout condition or the document could not be transferred
because a 'soft link' pointing to the document could not be
resolved."
::= { wwwDocLastNEntry 6 }
wwwDocLastNBytes OBJECT-TYPE
SYNTAX Unsigned32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of content bytes that were returned as a
result of this attempt to access a document."
::= { wwwDocLastNEntry 7 }The wwwDocLastNIndex one is the sliding-window boss 🪟. The first access gets index 1, every access after that counts up, and once you pass the window size you only see the most recent slice. There's also a lock so a manager can read the table without it changing under them 🔒
Now the bucket summaries 🪣. Each bucket records when it was made available, plus its total accesses, distinct documents, and bytes transferred over that bucket's time interval.
wwwDocBucketTable OBJECT-TYPE
SYNTAX SEQUENCE OF WwwDocBucketEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This table provides administrative summary information for
the buckets maintained per WWW service."
::= { wwwDocumentStatistics 3 }
wwwDocBucketEntry OBJECT-TYPE
SYNTAX WwwDocBucketEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"An entry which describes the parameters associated with a
particular bucket."
INDEX { wwwServiceIndex, wwwDocBucketIndex }
::= { wwwDocBucketTable 1 }
WwwDocBucketEntry ::= SEQUENCE {
wwwDocBucketIndex Unsigned32,
wwwDocBucketTimeStamp DateAndTime,
wwwDocBucketAccesses Unsigned32,
wwwDocBucketDocuments Unsigned32,
wwwDocBucketBytes Unsigned32
}
wwwDocBucketIndex OBJECT-TYPE
SYNTAX Unsigned32 (1..4294967295)
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"An arbitrary monotonically increasing integer number
used for indexing the wwwDocBucketTable. The index number
wraps to 1 whenever the maximum value is reached."
::= { wwwDocBucketEntry 1 }
wwwDocBucketTimeStamp OBJECT-TYPE
SYNTAX DateAndTime
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The date and time when the bucket was made available."
::= { wwwDocBucketEntry 2 }
wwwDocBucketAccesses OBJECT-TYPE
SYNTAX Unsigned32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The total number of access attempts for any document
provided by this WWW service during the time interval
over which this bucket was created."
::= { wwwDocBucketEntry 3 }
wwwDocBucketDocuments OBJECT-TYPE
SYNTAX Unsigned32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The total number of different documents for which access
was attempted this this WWW service during the time interval
over which this bucket was created."
::= { wwwDocBucketEntry 4 }
wwwDocBucketBytes OBJECT-TYPE
SYNTAX Unsigned32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The total number of content bytes which were transferred
from this WWW service during the time interval over which
this bucket was created."
::= { wwwDocBucketEntry 5 }Last but definitely not least, the leaderboards 🏆👑. The access top-N table ranks documents by how often they were hit, with bytes as the tiebreaker, and the bytes top-N table ranks them by how much traffic they caused.
wwwDocAccessTopNTable OBJECT-TYPE
SYNTAX SEQUENCE OF WwwDocAccessTopNEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The table of the most frequently accessed documents in a
given bucket. This table is sorted by the column
wwwDocAccessTopNAccesses. Entries having the same number
of accesses are secondarily sorted by wwwDocAccessTopNBytes.
Entries with the same number of accesses and the same
number of bytes will have an arbitrary order."
::= { wwwDocumentStatistics 4 }
wwwDocAccessTopNEntry OBJECT-TYPE
SYNTAX WwwDocAccessTopNEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"An entry in the top N table sorted by document accesses."
INDEX { wwwServiceIndex, wwwDocBucketIndex,
wwwDocAccessTopNIndex }
::= { wwwDocAccessTopNTable 1 }
WwwDocAccessTopNEntry ::= SEQUENCE {
wwwDocAccessTopNIndex Unsigned32,
wwwDocAccessTopNName WwwDocName,
wwwDocAccessTopNAccesses Unsigned32,
wwwDocAccessTopNBytes Unsigned32,
wwwDocAccessTopNLastResponseType WwwResponseType
}
wwwDocAccessTopNIndex OBJECT-TYPE
SYNTAX Unsigned32 (1..4294967295)
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"An arbitrary monotonically increasing integer number
used for indexing the wwwDocAccessTopNTable. The index is
inversely correlated to the sorting order of the table. The
document with the highest access count will get the index
value 1."
::= { wwwDocAccessTopNEntry 1 }
wwwDocAccessTopNName OBJECT-TYPE
SYNTAX WwwDocName
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The name of the document for which access was attempted."
::= { wwwDocAccessTopNEntry 2 }
wwwDocAccessTopNAccesses OBJECT-TYPE
SYNTAX Unsigned32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The total number of access attempts for this document."
::= { wwwDocAccessTopNEntry 3 }
wwwDocAccessTopNBytes OBJECT-TYPE
SYNTAX Unsigned32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The total number of content bytes that were transmitted
as a result of attempts to access this document."
::= { wwwDocAccessTopNEntry 4 }
wwwDocAccessTopNLastResponseType OBJECT-TYPE
SYNTAX WwwResponseType
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The protocol response type which was sent to the client
as a result of the last attempt to access this document.
This object contains the type of the primary response if
there were multiple responses to a single request."
::= { wwwDocAccessTopNEntry 5 }
wwwDocBytesTopNTable OBJECT-TYPE
SYNTAX SEQUENCE OF WwwDocBytesTopNEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The table of the documents which caused most network
traffic in a given bucket. This table is sorted by the
column wwwDocBytesTopNBytes. Entries having the same number
bytes are secondarily sorted by wwwDocBytesTopNAccesses.
Entries with the same number of accesses and the same
number of bytes will have an arbitrary order."
::= { wwwDocumentStatistics 5 }That's the stats crew wrapped for this part 🌈💖 The bytes top-N table gets its full spread in the next part, so stay tuned 🦋
wwwDocBytesTopNEntry OBJECT-TYPE
SYNTAX WwwDocBytesTopNEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"An entry in the top N table sorted by network traffic."
INDEX { wwwServiceIndex, wwwDocBucketIndex,
wwwDocBytesTopNIndex }
::= { wwwDocBytesTopNTable 1 }
WwwDocBytesTopNEntry ::= SEQUENCE {
wwwDocBytesTopNIndex Unsigned32,
wwwDocBytesTopNName WwwDocName,
wwwDocBytesTopNAccesses Unsigned32,
wwwDocBytesTopNBytes Unsigned32,
wwwDocBytesTopNLastResponseType WwwResponseType
}
wwwDocBytesTopNIndex OBJECT-TYPE
SYNTAX Unsigned32 (1..4294967295)
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"An arbitrary monotonically increasing integer number
used for indexing the wwwDocBytesTopNTable. The index is
inversely correlated to the sorting order of the table. The
document with the highest byte count will get the index
value 1."
::= { wwwDocBytesTopNEntry 1 }
wwwDocBytesTopNName OBJECT-TYPE
SYNTAX WwwDocName
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The name of the document for which access was attempted."
::= { wwwDocBytesTopNEntry 2 }
wwwDocBytesTopNAccesses OBJECT-TYPE
SYNTAX Unsigned32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The total number of access attempts for this document."
::= { wwwDocBytesTopNEntry 3 }
wwwDocBytesTopNBytes OBJECT-TYPE
SYNTAX Unsigned32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The total number of content bytes that were transmitted
as a result of attempts to access this document."
::= { wwwDocBytesTopNEntry 4 }
wwwDocBytesTopNLastResponseType OBJECT-TYPE
SYNTAX WwwResponseType
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The protocol response type which was sent to the client
as a result of the last attempt to access this document.
This object contains the type of the primary response if
there were multiple responses to a single request."
::= { wwwDocBytesTopNEntry 5 }
--
-- Conformance Definitions
--
wwwMIBCompliances OBJECT IDENTIFIER ::= { wwwMIBConformance 1 }
wwwMIBGroups OBJECT IDENTIFIER ::= { wwwMIBConformance 2 }
wwwMinimalCompliance MODULE-COMPLIANCE
STATUS current
DESCRIPTION
"The compliance statement for SNMP agents which implement
the minimal subset of the WWW-MIB. Implementors might
choose this subset for high-performance server where
full compliance might be to expensive."
MODULE -- this module
MANDATORY-GROUPS {
wwwServiceGroup,
wwwSummaryGroup
}
OBJECT wwwSummaryOutRequests
DESCRIPTION
"Instances of wwwSummaryOutRequests do not exist on pure
WWW server implementations."
OBJECT wwwSummaryInResponses
DESCRIPTION
"Instances of wwwSummaryOutRequests do not exist on pure
WWW server implementations."
OBJECT wwwSummaryInRequests
DESCRIPTION
"Instances of wwwSummaryInRequests do not exist on pure
WWW client implementations."
OBJECT wwwSummaryOutResponses
DESCRIPTION
"Instances of wwwSummaryOutResponses do not exist on pure
WWW client implementations."
::= { wwwMIBCompliances 1 }
wwwFullCompliance MODULE-COMPLIANCE
STATUS current
DESCRIPTION
"The compliance statement for SNMP agents which implement
the full WWW-MIB."
MODULE -- this module
MANDATORY-GROUPS {
wwwServiceGroup,
wwwSummaryGroup
}
GROUP wwwRequestInGroup
DESCRIPTION
"The wwwRequestInGroup is mandatory only for WWW server
or proxy server implementations."
GROUP wwwResponseOutGroup
DESCRIPTION
"The wwwResponseOutGroup is mandatory only for WWW server
or proxy server implementations."
GROUP wwwRequestOutGroup
DESCRIPTION
"The wwwRequestOutGroup is mandatory only for WWW client
or proxy server implementations."
GROUP wwwResponseInGroup
DESCRIPTION
"The wwwRequestOutGroup is mandatory only for WWW client
or proxy server implementations."
GROUP wwwDocumentGroup
DESCRIPTION
"The wwwDocumentGroup is mandatory only for WWW server
or proxy server implementations."
OBJECT wwwSummaryOutRequests
DESCRIPTION
"Instances of wwwSummaryOutRequests do not exist on pure
WWW server implementations."
OBJECT wwwSummaryInResponses
DESCRIPTION
"Instances of wwwSummaryOutRequests do not exist on pure
WWW server implementations."
OBJECT wwwSummaryInRequests
DESCRIPTION
"Instances of wwwSummaryInRequests do not exist on pure
WWW client implementations."
OBJECT wwwSummaryOutResponses
DESCRIPTION
"Instances of wwwSummaryOutResponses do not exist on pure
WWW client implementations."
::= { wwwMIBCompliances 2 }
wwwServiceGroup OBJECT-GROUP
OBJECTS {
wwwServiceDescription,
wwwServiceContact,
wwwServiceProtocol,
wwwServiceName,
wwwServiceType,
wwwServiceStartTime,
wwwServiceOperStatus,
wwwServiceLastChange
}
STATUS current
DESCRIPTION
"A collection of objects providing information about
the WWW services known by the SNMP agent."
::= { wwwMIBGroups 1 }
wwwSummaryGroup OBJECT-GROUP
OBJECTS {
wwwSummaryInRequests,
wwwSummaryOutRequests,
wwwSummaryInResponses,
wwwSummaryOutResponses,
wwwSummaryInBytes,
wwwSummaryInLowBytes,
wwwSummaryOutBytes,
wwwSummaryOutLowBytes
}
STATUS current
DESCRIPTION
"A collection of objects providing summary statistics
about requests and responses generated and received
by a WWW service."
::= { wwwMIBGroups 2 }
wwwRequestInGroup OBJECT-GROUP
OBJECTS {
wwwRequestInRequests,
wwwRequestInBytes,
wwwRequestInLastTime
}
STATUS current
DESCRIPTION
"A collection of objects providing detailed statistics
about requests received by a WWW service."
::= { wwwMIBGroups 3 }
wwwRequestOutGroup OBJECT-GROUP
OBJECTS {
wwwRequestOutRequests,
wwwRequestOutBytes,
wwwRequestOutLastTime
}
STATUS current
DESCRIPTION
"A collection of objects providing detailed statistics
about requests generated by a WWW service."
::= { wwwMIBGroups 4 }
wwwResponseInGroup OBJECT-GROUP
OBJECTS {
wwwResponseInResponses,
wwwResponseInBytes,
wwwResponseInLastTime
}
STATUS current
DESCRIPTION
"A collection of objects providing detailed statistics
about responses received by a WWW service."
::= { wwwMIBGroups 5 }
wwwResponseOutGroup OBJECT-GROUP
OBJECTS {
wwwResponseOutResponses,
wwwResponseOutBytes,
wwwResponseOutLastTime
}
STATUS current
DESCRIPTION
"A collection of objects providing detailed statistics
about responses generated by a WWW service."
::= { wwwMIBGroups 6 }
wwwDocumentGroup OBJECT-GROUP
OBJECTS {
wwwDocCtrlLastNSize,
wwwDocCtrlLastNLock,
wwwDocCtrlBuckets,
wwwDocCtrlBucketTimeInterval,
wwwDocCtrlTopNSize,
wwwDocLastNName,
wwwDocLastNTimeStamp,
wwwDocLastNRequestType,
wwwDocLastNResponseType,
wwwDocLastNStatusMsg,
wwwDocLastNBytes,
wwwDocBucketTimeStamp,
wwwDocBucketAccesses,
wwwDocBucketDocuments,
wwwDocBucketBytes,
wwwDocAccessTopNName,
wwwDocAccessTopNAccesses,
wwwDocAccessTopNBytes,
wwwDocAccessTopNLastResponseType,
wwwDocBytesTopNName,
wwwDocBytesTopNAccesses,
wwwDocBytesTopNBytes,
wwwDocBytesTopNLastResponseType
}
STATUS current
DESCRIPTION
"A collection of objects providing information about
accesses to documents."
::= { wwwMIBGroups 7 }
END7. Document Transfer Protocol Mappings 🦋
okay bestie, this bit is all about how real protocols like HTTP [19,20] and FTP [21] get plugged into the abstract Document Transfer Protocol (DTP) that the WWW MIB is built on 🧚. Every mapping has to define the identifier that uniquely identifies the transfer protocol. Mappings also need to say how requests and responses get identified ✨. It's giving "everything has a name tag" energy, and I'm obsessed 💖
7.1. The HyperText Transfer Protocol 🌸
so HTTP [19,20] is an application-level protocol used to move hypermedia documents around a distributed networked environment 🌈. It runs on the request/response paradigm, which means it maps onto the abstract DTP pretty easily, no cap 💅
HTTP usually runs over TCP and sits on the well-known TCP port 80 🎀. So the default value for the wwwServiceProtocol object is { applTCPProtoID 80 }. Iconic ✨
HTTP allows both requests and responses, plus an open-ended set of message types 🫶. Because of that, the mapping uses the general message syntax of HTTP. Here's the BNF for the general HTTP message syntax as defined in [20], which is literally the whole vibe:
generic-message = start-line
*message-header
CRLF
[ message-body ]
start-line = Request-Line | Status-Line
Request-Line = Method SP Request-URI SP HTTP-Version CRLF
Status-Line = HTTP-Version SP Status-Code SP Reason-Phrase CRLFQuick check: any HTTP-message whose start-line is a Request-Line counts as a request in the abstract DTP 📬. Any HTTP-message whose start-line is a Status-Line counts as a response in the abstract DTP 📭.
And here's how the types map over, bestie 👑:
- WwwRequestType corresponds to the method token in the Request-Line 💜.
- WwwResponseType corresponds to the Status-Code in the Status-Line 🍓.
7.2. The File Transfer Protocol ✨
okay so FTP (the File Transfer Protocol) [21] is an application-level protocol for moving files between hosts that talk over the TCP/IP suite 📁 it's built on a request/response vibe, and it gets mapped onto the abstract DTP in this section. Here's the FTP model from [21], which is honestly kind of iconic 💅
-------------
|+---------+|
|| User || --------
||Interface|<--->| User |
|+----|----+| --------
---------- | | |
|+------+| control connection |+----|----+|
||Server|<------------------->|| Client ||
|| PI || Commands/Replies || PI ||
|+--|---+| |+----|----+|
| | | | | |
-------- |+--|---+| Data |+----|----+| --------
| File |<--->|Server|<------------------->|| Client |<--->| File |
|System| || DTP || Connection || DTP || |System|
-------- |+------+| |+---------+| --------
---------- -------------FTP uses two different connection types between a client and a server 🦋 the control connection is persistent for the whole FTP session and is used to swap FTP commands and their replies. The data connection only shows up when there's bulk data to move, so it's giving "pop in when needed" energy 🎀
The FTP protocol usually runs over TCP and uses the well-known TCP port 21 to set up the control connection 🌸 so the default value for the wwwServiceProtocol object is { applTCPProtoID 21 }. Simple, clean, no notes 💖
Every FTP command counts as a request in the abstract DTP, and every FTP reply counts as a response ✨ ngl, it's worth knowing that one single FTP command can get multiple FTP replies (for example, preliminary positive replies) 🙈 The primary response to an FTP request carries a status code of the form 2xy, 3xy, 4xy or 5xy. For what those codes actually mean, check section 4.2 in [21]. Here's how the WwwRequestType and WwwResponseType get mapped:
- The WwwRequestType corresponds to the FTP command token.
- The WwwResponseType corresponds to the three-digit code which starts a reply. Multi-line replies with the same three-digit code are counted as a single DTP response. 🫶
8. Security Considerations 🔐
bestie, this part is serious, so listen up 🙈 there are a bunch of management objects in this MIB module with a MAX-ACCESS clause of read-write. Those objects can be sensitive or vulnerable in some network environments. Turning on write operations in a non-secure environment without proper protection can seriously mess with network operations 💀
There are also several managed objects in this MIB that may hold sensitive information:
- The document statistics group contains traffic information, including the names of documents that were the target of protocol operations. This info is sensitive because it lets someone get access statistics for documents 👀
- The protocol statistics are less sensitive, since they don't include details about the target of individual requests and responses. Still, traffic statistics and error counters give usage info about WWW services and about the overall quality of those services 📊 It is suggested that sites configure MIB views so that a user of this MIB can only access the portion of the statistics that belongs to the WWW services managed by that user.
- The service and the summary statistics groups provide information about the existence of WWW services and condensed usage statistics. Some sites may want to protect this too, especially if they run private WWW services that the outside world shouldn't know about 🤫
SNMPv1 by itself is not a secure environment 💀 Even if the network itself is secure (for example, by using IPSec), there's no control over who on that secure network is allowed to access (read/change/create/delete) the objects in this MIB.
It is recommended that implementers consider the security features provided by the SNMPv3 framework 🛡️ specifically, the use of the User-based Security Model RFC 2574 [12] and the View-based Access Control Model RFC 2575 [15] is recommended.
It is then a customer/user responsibility to make sure the SNMP entity giving access to an instance of this MIB is properly configured, so access to the objects is only given to those principals (users) who have legitimate rights to read or write (change/create/delete) them. No loopholes, periodt 💅
9. Intellectual Property 📜
The IETF takes no position on the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this document, or on the extent to which any license under such rights might or might not be available. It also doesn't represent that it has made any effort to identify any such rights. Info on the IETF's procedures for rights in standards-track and standards-related documentation can be found in BCP-11. Copies of claims of rights made available for publication, any assurances of licenses to be made available, or the result of an attempt to obtain a general license or permission for the use of such proprietary rights by implementers or users of this specification can be obtained from the IETF Secretariat.
The IETF invites any interested party to bring to its attention any copyrights, patents or patent applications, or other proprietary rights which may cover technology that may be required to practice this standard. Please send that info to the IETF Executive Director 🫶
10. Acknowledgments 💜
This document was produced by the Application MIB working group. The editors gratefully acknowledge the comments of the following individuals:
Mark Gamble, Cheryl Krupczak, Randy Presuhn, Jon Saperia, Bob Stewart, Martin Toet, Chris Wellens, Kenneth White.
11. Editors' Addresses 📬
Harrie Hazewinkel
Joint Research Centre of the E.C.
via Fermi - Ispra 21020 (VA)
Italy
Phone: +39 0332786322
Fax: +39 0332785641
EMail: harrie.hazewinkel@jrc.it
Carl W. Kalbfleisch
Verio, Inc.
1950 Stemmons Frwy
Suite 2006
Dallas, TX 75207
USA
Phone: +1 214 290-8653
Fax: +1 214 744-0742
EMail: cwk@verio.net
Juergen Schoenwaelder
TU Braunschweig
Bueltenweg 74/75
38106 Braunschweig
Germany
Phone: +49 531 391-3683
Fax: +49 531 489-5936
EMail: schoenw@ibr.cs.tu-bs.de12. References 📚
- [1] Wijnen,, B., Harrington, D. and R. Presuhn, "An Architecture for Describing SNMP Management Frameworks", RFC 2571, April 1999.
- [2] Rose, M. and K. McCloghrie, "Structure and Identification of Management Information for TCP/IP-based Internets", STD, 16, RFC 1155, May 1990.
- [3] Rose, M. and K. McCloghrie, "Concise MIB Definitions", STD 16, RFC 1212, Performance Systems International, March 1991.
- [4] Rose, M., "A Convention for Defining Traps for use with the SNMP", RFC 1215, March 1991.
- [5] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., Rose, M. and S. Waldbusser, "Structure of Management Information Version 2 (SMIv2)", STD 58, RFC 2578, April 1999.
- [6] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., Rose, M. and S. Waldbusser, "Textual Conventions for SMIv2", STD 58, RFC 2579, April 1999.
- [7] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., Rose, M. and S. Waldbusser, "Conformance Statements for SMIv2", STD 58, RFC 2580, April 1999.
- [8] Case, J., Fedor, M., Schoffstall, M. and J. Davin, "Simple Network Management Protocol", STD 15, RFC 1157, May 1990.
- [9] Case, J., McCloghrie, K., Rose, M. and S. Waldbusser, "Introduction to Community-based SNMPv2", RFC 1901, January 1996.
- [10] Case, J., McCloghrie, K., Rose, M. and S. Waldbusser, "Transport Mappings for Version 2 of the Simple Network Management Protocol (SNMPv2)", RFC 1906, January 1996.
- [11] Case, J., Harrington D., Presuhn R. and B. Wijnen, "Message Processing and Dispatching for the Simple Network Management Protocol (SNMP)", RFC 2572, April 1999.
- [12] Blumenthal, U. and B. Wijnen, "User-based Security Model (USM) for version 3 of the Simple Network Management Protocol (SNMPv3)", RFC 2574, April 1999.
- [13] Case, J., McCloghrie, K., Rose, M. and S. Waldbusser, "Protocol Operations for Version 2 of the Simple Network Management Protocol (SNMPv2)", RFC 1905, January 1996.
- [14] Levi, D., Meyer, P. and B. Stewart, "SNMP Applications", RFC 2573, April 1999.
- [15] Wijnen, B., Presuhn, R. and K. McCloghrie, "View-based Access Control Model (VACM) for the Simple Network Management Protocol (SNMP)", RFC 2575, April 1999.
- [16] Hovey, R. and S. Bradner, "The Organizations Involved in the IETF Standards Process", BCP 11, RFC 2028, October 1996.
- [17] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997.
- [18] Berners-Lee, T., Fielding, R. and L. Masinter, "Uniform Resource Identifiers (URI): Generic Syntax", RFC 2396, August 1998.
- [19] Berners-Lee, T., Fielding, R. and H. Frystyk, "Hypertext Transfer Protocol -- HTTP/1.0", RFC 1945, May 1996.
- [20] Fielding, R., Gettys, J., Mogul, J., Frystyk, H. and T. Berners-Lee, "Hypertext Transfer Protocol -- HTTP/1.1", RFC 2068, January 1997.
- [21] Postel, J. and J. Reynolds, "File Transfer Protocol (FTP)", STD 9, RFC 959, October 1985.
- [22] Kalbfleisch, C., "Applicability of Standards Track MIBs to Management of World Wide Web Servers", RFC 2039, November 1996.
- [23] Krupczak, C. and J. Saperia, "Definitions of System-Level Managed Objects for Applications", RFC 2287, February 1998.
- [24] Kalbfleisch, C., Krupczak, C., Presuhn, R. and J. Saperia, "Application Management MIB", RFC 2564, May 1999.
- [25] Kantor, B. and P. Lapsley, "Network News Transfer Protocol: A Proposed Standard for the Stream-Based Transmission of News", RFC 977, February 1986.
- [26] Callaghan, B., "WebNFS Client Specification", RFC 2054, October 1996
- [27] Callaghan, B., "WebNFS Server Specification", RFC 2055, October 1996.
13. Full Copyright Statement ✨
Copyright (C) The Internet Society (1999). All Rights Reserved. 🌸
Okay bestie, this is the legal bit, but it's actually pretty chill 💅 You can copy this document and pass it around, and you can translate it too. You can also make derivative works that comment on or explain it, or help people implement it, and publish and share those however you want, whole or in part. The one rule is that the copyright notice and this paragraph have to be included on every copy and every derivative work 🫶
Here's the catch: the document itself may not be modified in any way. You can't remove the copyright notice, and you can't remove the references to the Internet Society or other Internet organizations. There are two exceptions. You can change it as needed for developing Internet standards, but then the copyright procedures in the Internet Standards process have to be followed. You can also change it as required to translate it into languages other than English 🌍
The permissions above are perpetual, meaning they last forever, and the Internet Society or its successors or assigns will never revoke them 💖
Now the disclaimer, which is in caps because it's serious 😭
This document and the information contained herein is provided on an "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. 🙈
Acknowledgement 🎀
Funding for the RFC Editor function is currently provided by the Internet Society. 👑
📦 where this page comes from
- ietf: rfc2594 1999-05
- 💖 girlified by claude-haiku-5-5 on : a language model's rewrite of the original, under its terms