pcp
[Top] [All Lists]

PCP books status and planning

To: pcp@xxxxxxxxxxx
Subject: PCP books status and planning
From: Nathan Scott <nathans@xxxxxxxxxx>
Date: Sun, 25 Aug 2013 02:36:03 -0400 (EDT)
Cc: Chris Wengelski <chrisw@xxxxxxx>
Delivered-to: pcp@xxxxxxxxxxx
In-reply-to: <495275782.5232360.1377397630538.JavaMail.root@xxxxxxxxxx>
References: <1852342740.4159092.1376645760219.JavaMail.root@xxxxxxxxxx> <1459024390.4164300.1376646902350.JavaMail.root@xxxxxxxxxx> <y0mr4dl7g95.fsf@xxxxxxxx> <495275782.5232360.1377397630538.JavaMail.root@xxxxxxxxxx>
Reply-to: Nathan Scott <nathans@xxxxxxxxxx>
Thread-index: t4dmIEPGvx7wN4bKcBsgNoJdYGK/+DHQGwLf
Thread-topic: Book reviewers sought
Hi all,

I've updated the UAG with fixes for most of Franks review comments
and uploaded a new pdf to the website.  Still keen to hear from
other reviewers as well, esp kenj re the open is-the-PMCS-acronym-
really-useful topic.

I've also put up an initial draft of the revised Programmers Guide
(PG) and again would like to hear comments anyone has.  The PG has
atrophied more quickly than the UAG and there are several areas we
should collectively attempt to address I think.  I've outlined the
areas I identified on my initial pass through and just for grins I
have put content-experts next to some in the vague hope others may
take some of this work on, as time permits.  However, all areas
are wide open to anyone - please help out if you can.

(The items marked [*] below I plan to tackle next week).

"PCP Users And Administrators Guide" remaining items:
- pmwebd deployment could be better documented (but perhaps it'll
  make sense to wait until after https is coded before taking on)
- collect2pcp, sar2pcp and friends ... not covered at all, nor is
  the general idea of being able to import external data into PCP
  archives (some coverage also belongs in PG, some in Tutorials).

"PCP Programmers Guide" remaining items:
- Event tracing coverage missing in PMAPI (nathans[*])
- PMWEBAPI needs a chapter covering the API, ala the PMAPI and PMDA
  API chapters.  (fche?)
- Python interfaces need coverage.  (scox?)
- PMIMPORT needs a chapter.  (kenj?  nathans?  marko?  mgoodwin?)
  - Kens got good content in the tutorial already, mainly cover API
- PMDA interface discussion is missing coverage of:
  - pmdaCache concepts, interfaces, examples
  - dynamic namespace concepts, interfaces, examples
  - connection attributes (credentials) concepts, interfaces
  - event tracing concepts, queueing, interfaces, examples
- Chapter 4 should be renamed "Instrumenting Applications"
  - MMV PMDA coverage needs to be added (nathans[*])
  - C/C++, Python, Perl client APIs (nathans[*])
  - Java client API (Parfait, possibly a chapter to itself!)
  - Trace PMDA should be moved to the end of this new chapter
    - In general, we should continue to plan for a v2 pmdatrace
      (as mentioned in the book);
    - so, planning to leave these docs as-is until that time.

"PCP Tutorials and Case Studies" remaining items:
- Convert existing content to DocBook format; drop any content that
  is already better-covered in the other books or too-dated-to-fix.
  (nathans[*])
- Update "Analysing processor utilisation" to be not IRIX-specific.
- Update "Analysing storage performance", likewise.
- Rewrite "Management framework integration", need to cover open
  solutions like Nagios & puppet (nathans, someone in Aconex ops?)
- New HowTo-style case study based on Aconex experience evaluating
  RHEL5->6 platform transition (nathans)


cheers.

--
Nathan

<Prev in Thread] Current Thread [Next in Thread>