Open Services for Lifecycle Collaboration Performance Monitoring Vocabulary

Status: Under Construction Draft covering 2.0 Scenarios - 2 May 2012

NOTE: This version of the specification has version 2.0 to indicate that it is an OSLC Core 2.0 compliant specification. This specification is the initial version of an OSLC Performance Monitoring specification.

This Version

• http://open-services.net/bin/view/Main/PmSpecificationV2

• http://open-services.net/bin/view/Main/PmSpecificationV2

• N/A

• JohnArwe

Contributors

• See Contributors section below.

Table of Contents

License

This work is licensed under a Creative Commons Attribution License.

Notation and Conventions

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 RFC2119. Domain name examples use RFC2606.

Introduction

(this section is informative)

This specification builds on the OSLC Core Specification to define the resources and operations supported by an Open Services for Lifecycle Collaboration (OSLC) Performance Monitoring provider.

Performance Monitoring resources define records whose content is most useful in the operational stage of the software development, test and deployment lifecycle. They represent individual resources as well as their relationships to other resources and to other linked resources outside of the Performance Monitoring domain. The intent of this specification is to define the set of HTTP-based RESTful interfaces in terms of HTTP methods: GET, POST, PUT and DELETE, HTTP response codes, MIME type handling and resource formats. The capabilities of the interface definitions are driven by key integration scenarios and therefore don't represent a complete setup of operations on resources or resource types. The resource formats and operations may not match exactly the native models supported by existing implementations but are intended to be compatible with them.

Performance Monitoring, as referenced in this specification, refers to the collection of data about IT systems such as servers, workstations, services, and transactions to assess their operational health and enable proactive manual human intervention before emerging problems escalate into widespread degradation or outages. See the PmScenarios? page for several specific examples.

Terminology

Service Provider - an implementation of the OSLC Performance Monitoring specification as a server. OSLC Performance Monitoring clients consume these services.

Performance Monitoring Resource - A resource managed by a Performance Monitoring service provider. The types of resources defined by this specification are FILL ME IN LATER.

Performance Monitoring Record - Defines the unit of information made available by a Performance Monitoring service provider.

Resource Definitions

The Performance Monitoring resource properties are not limited to the ones defined in this specification; service providers may provide additional properties. It is recommended that any additional properties exist in their own unique namespace and not use the namespaces defined in this specification.

A list of properties is defined for each type of resource. Most of these properties are identified in OSLC Core Appendix A: Common Properties. Any exceptions are noted. Relationship properties refer to other resources. These resources may be in any OSLC domain (including Performance Monitoring).

The diagram below shows the relationships between Performance Monitoring Resources. We need to draft resource definition(s) before more editing.

Resource: Performance Monitoring Record

• Name: PerformanceMonitoringRecord
• Description: A resource representing performance monitoring information.
• Type URI http://open-services.net/ns/perfmon#PerformanceMonitoringRecord

PerformanceMonitoringRecord Properties

Appendix A: Samples (this section is informative)

See PmSpecificationV2Samples

Appendix C: Notices and References

Contributors

Reporting Issues

The working group participants who author and maintain this document monitor a distribution list where issues or questions can be raised, see Performance Monitoring Mailing List

Also the issues found with this specification and their resolution can be found at PmSpecificationV2Issues? .

Authors and Contact Information

• JohnArwe (IBM)
• JulianneBielski (IBM)

Intellectual Property Covenant

The members of the Working Group (or as appropriate, their employers) have documented a Patent Non-Assertion Covenant and/or Patent License for implementations of Specifications based on this vocabulary, e.g. the Performance Monitoring 2.0 Specification, as described in the open-services.net Terms of Use.

References

• OSLC Core - OSLC Core Specification 2.0
• Dublin Core 1.1 - Dublin Core Metadata Element Set, Version 1.1
• FOAF - Friend of a Friend (FOAF) v0.98
• HTTP 1.1 - Hyper-text Transfer Protocol (HTTP/1.1)
• OAuth 1.0a - RFC5849 - The OAuth 1.0 Protocol
• RDF/XML Concepts - RDF/XML Concepts and Abstract Syntax
• RDF/XML Syntax - RDF / XML Syntax Specification (Revised)
• URI Syntax - URI Generic Syntax
• XML Namespaces - Namespaces in XML 1.0 (Third Edition)
• XSD Datatypes - XML Schema Part 2: Datatypes Second Edition