journald: Add documentation

8 files changed, 586 insertions, 3 deletions

diff --git a/openlmi-providers.spec b/openlmi-providers.spec
index a76f6f4..6768322 100644
--- a/openlmi-providers.spec
+++ b/openlmi-providers.spec
@@ -3,7 +3,7 @@
 
 Name:           openlmi-providers
 Version:        0.4.0
-Release:        2%{?dist}
+Release:        3%{?dist}
 Summary:        Set of basic CIM providers
 
 License:        LGPLv2+
@@ -301,6 +301,14 @@ The openlmi-journald package contains CMPI providers for systemd journald
 service, allowing listing, iterating through and writing new message log
 records.
 
+%package -n openlmi-journald-doc
+Summary:        CIM Journald provider documentation
+Group:          Documentation
+BuildArch:      noarch
+
+%description -n openlmi-journald-doc
+This package contains the documents for OpenLMI Journald provider.
+
 %prep
 %setup -q
 
@@ -324,7 +332,7 @@ pushd src/pcp
 popd
 
 # documentation
-for provider in account fan logicalfile realmd service-dbus; do
+for provider in account fan logicalfile realmd service-dbus journald; do
     make -C src/${provider}/doc html
 done
 make -C src/software/doc/admin html
@@ -376,7 +384,7 @@ touch $RPM_BUILD_ROOT/%{_localstatedir}/lib/%{name}/stamp
 # documentation
 install -m 755 -d $RPM_BUILD_ROOT/%{_docdir}/%{name}
 install -m 644 README COPYING $RPM_BUILD_ROOT/%{_docdir}/%{name}
-for provider in account fan logicalfile realmd; do
+for provider in account fan logicalfile realmd journald; do
     install -m 755 -d $RPM_BUILD_ROOT/%{_docdir}/%{name}/${provider}/admin_guide
     cp -pr src/${provider}/doc/build/html/* $RPM_BUILD_ROOT/%{_docdir}/%{name}/${provider}/admin_guide
 done
@@ -559,6 +567,9 @@ cp -pr tools/openlmitheme/* $RPM_BUILD_ROOT/%{python_sitelib}/sphinx/themes/open
 %{_datadir}/%{name}/90_LMI_Journald_Profile.mof
 %attr(755, root, root) %{_libexecdir}/pegasus/cmpiLMI_Journald-cimprovagt
 
+%files -n openlmi-journald-doc
+%{_docdir}/%{name}/journald/
+
 %pre
 # If upgrading, deregister old version
 if [ "$1" -gt 1 ]; then
@@ -877,6 +888,9 @@ if [ "$1" -eq 0 ]; then
 fi >> %logfile 2>&1
 
 %changelog
+* Fri Oct 18 2013 Tomas Bzatek <tbzatek@redhat.com> 0.4.0-3
+- Added journald documentation
+
 * Thu Oct 17 2013 Michal Minar <miminar@redhat.com> 0.4.0-2
 - Added documentation package for fan provider.
 
diff --git a/src/journald/doc/Makefile b/src/journald/doc/Makefile
new file mode 100644
index 0000000..78f87c9
--- /dev/null
+++ b/src/journald/doc/Makefile
@@ -0,0 +1,159 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = build
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext mof
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+mof:
+	make -C source/mof
+
+mof-clean:
+	make -C source/mof clean
+
+clean: mof-clean
+	-rm -rf $(BUILDDIR)/*
+
+html: mof
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/OpenLMIService.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/OpenLMIService.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/OpenLMIService"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/OpenLMIService"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
diff --git a/src/journald/doc/source/conf.py b/src/journald/doc/source/conf.py
new file mode 100644
index 0000000..68508f7
--- /dev/null
+++ b/src/journald/doc/source/conf.py
@@ -0,0 +1,247 @@
+# -*- coding: utf-8 -*-
+#
+# OpenLMI Account documentation build configuration file, created by
+# sphinx-quickstart
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+def setup(app):
+    # Register new option to include class list and class tree in index.rst
+    app.add_config_value('includeClasses', 'True', True)
+includeClasses = True
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration -----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = ['sphinx.ext.ifconfig', 'sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.viewcode']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'OpenLMI Journald'
+copyright = u'2013, Red Hat Inc.'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '0.3.0'
+# The full version, including alpha/beta/rc tags.
+release = '0.3.0'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = []
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'openlmitheme'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+html_theme_path = ['../../../../tools/']
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'OpenLMIJournaldDoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('index', 'OpenLMIJournald.tex', u'OpenLMI Journald Documentation',
+   u'Tomas Bzatek', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'OpenLMIJournald', u'OpenLMI Journald Documentation',
+     [u'Tomas Bzatek'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output ------------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+  ('index', 'OpenLMIJournald', u'OpenLMI Journald Documentation',
+   u'Tomas Bzatek', 'OpenLMIJournald', 'Journald provider documentation.',
+   'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
diff --git a/src/journald/doc/source/index.rst b/src/journald/doc/source/index.rst
new file mode 100644
index 0000000..ddb93e4
--- /dev/null
+++ b/src/journald/doc/source/index.rst
@@ -0,0 +1,91 @@
+OpenLMI Journald Provider documentation
+=======================================
+
+OpenLMI Journald is a CIM provider exposing `systemd <http://freedesktop.org/wiki/Software/systemd/>`_
+journald log records and basic means of iteration and log writing.
+
+Classes used by the provider were chosen to mimic the sblim-cmpi-syslog provider
+set of classes allowing drop-in replacement in production tools. We haven't been
+able to find a profile it conforms to though. There's a related DMTF profile
+`DSP1010 "Record Log Profile" <http://www.dmtf.org/sites/default/files/standards/documents/DSP1010_2.0.0.pdf>`_
+which may be subject to extension of this provider in the future.
+As a benefit, by using the parent classes (e.g. :ref:`CIM_LogRecord<CIM-LogRecord>`), one is able
+to mix log records from orthodox syslog and journald together.
+
+
+Provider features
+------------------
+
+This is a short list of provider features:
+ * log records reading
+ * log record iteration using persistent iterators
+ * new records indication
+ * writing new log records
+
+For the moment, global journal is used, all journal files are mixed together.
+
+The provider also comes with a test suite covering most of its functionality.
+
+
+.. _inst-enum-limit:
+
+Number of LMI_JournalLogRecord instances enumerated limitation
+--------------------------------------------------------------
+
+Testing the provider showed up an issue with enumeration of :ref:`LMI_JournalLogRecord<LMI-JournalLogRecord>`
+instances. On the testing machine there was 199583 journal records, which is
+simply too much for the CIMOM, exceeding memory and the resulting XML reply
+limits.
+
+An artificial limit has been set, currently to 1000 most recent records. This
+limit is set by the ``JOURNAL_MAX_INSTANCES_NUM`` define in ``Journal.h`` source
+file.
+
+The  :ref:`LMI_JournalMessageLog<LMI-JournalMessageLog>` class provides several
+methods for iterating and seeking in a complete log.
+
+
+New log records writing security concerns
+-----------------------------------------
+
+The provider has an ability to send new messages to the log. This may be percieved
+as a security issue in someone's eyes as long as you can specify custom message
+format that is sent to the log. The only obstacle preventing anyone in sending
+spoof messages is the rather weak CIM authentication model.
+
+However, as long as journald is a structured logging system, further information
+is stored along every log record. Messages sent through the OpenLMI Journald
+provider may be identified by supplemental fields such as ``_COMM`` and ``_EXE``,
+pointing to a CIMOM that had been running the provider code or even the ``CODE_FUNC``
+field, pointing to a specific function that invoked the journald library code.
+
+
+Potential indications endless loop
+----------------------------------
+
+Just a note for implementing a system processing the indications. Having no
+specific filter for the indication subscription and performing an action
+within the indication handler that involves a message being sent to syslog
+may result in an endless loop as long such action generates another indication
+for the fresh syslog message. Even a CIMOM in certain situations (i.e. debugging
+in verbose mode) may generate additional messages while sending an indication
+that in turn will generate another one.
+
+
+Contents
+---------
+
+.. toctree::
+   :maxdepth: 2
+
+   usage
+
+.. ifconfig:: includeClasses
+
+   OpenLMI Journald CIM Classes:
+
+   .. toctree::
+      :maxdepth: 1
+
+      mof/tree
+      mof/index
diff --git a/src/journald/doc/source/mof/Makefile b/src/journald/doc/source/mof/Makefile
new file mode 100644
index 0000000..60a6074
--- /dev/null
+++ b/src/journald/doc/source/mof/Makefile
@@ -0,0 +1,14 @@
+all: index.rst
+
+TOPDIR=../../../../..
+MOFS=$(TOPDIR)/mof/60_LMI_Journald.mof
+
+clean:
+	rm -f *.rst
+
+index.rst: $(MOFS)
+	$(TOPDIR)/tools/openlmi-doc-class2rst -H header.txt -M `echo $(MOFS) | sed 's/ / -M /g'` \
+	    -S /usr/share/mof/cim-current/CIM_Schema.mof \
+	    -S $(TOPDIR)/mof/05_LMI_Qualifiers.mof \
+	    -S $(TOPDIR)/mof/30_LMI_Jobs.mof \
+	    `cat $(MOFS) | grep "^class" | cut -d ' ' -f 2 | sed 's/://'`
diff --git a/src/journald/doc/source/mof/header.txt b/src/journald/doc/source/mof/header.txt
new file mode 100644
index 0000000..cc06402
--- /dev/null
+++ b/src/journald/doc/source/mof/header.txt
@@ -0,0 +1,2 @@
+Class reference
+===============
diff --git a/src/journald/doc/source/usage.rst b/src/journald/doc/source/usage.rst
new file mode 100644
index 0000000..69fe48b
--- /dev/null
+++ b/src/journald/doc/source/usage.rst
@@ -0,0 +1,55 @@
+OpenLMI Journald usage
+======================
+
+The OpenLMI Journald provider depends on running journald daemon. See the `systemd
+<http://www.freedesktop.org/software/systemd/man/systemd-journald.service.html>`_
+manual for how to enable the journald service.
+
+
+Listing a log
+-------------
+
+This example shows simple enumeration through available :ref:`LMI_JournalLogRecord<LMI-JournalLogRecord>`
+instances in classic syslog-like format::
+
+    #!/usr/bin/lmishell
+    c = connect("localhost", "pegasus", "test")
+    for rec in c.root.cimv2.LMI_JournalMessageLog.first_instance().associators():
+        print "%s %s %s" % (rec.MessageTimestamp.datetime.ctime(), rec.HostName, rec.DataFormat)
+
+.. note::
+   Only a limited number of records are being enumerated and printed out, please
+   see the :ref:`inst-enum-limit` remark.
+
+
+Iterating through the log
+-------------------------
+
+This example uses iterator methods of the :ref:`LMI_JournalMessageLog<LMI-JournalMessageLog>`
+class to continuously go through the whole journal::
+
+    #!/usr/bin/lmishell
+    c = connect("localhost", "pegasus", "test")
+    inst = c.root.cimv2.LMI_JournalMessageLog.first_instance()
+    r = inst.PositionToFirstRecord()
+    iter_id = r.rparams['IterationIdentifier']
+    while True:
+        x = inst.GetRecord(IterationIdentifier=iter_id, PositionToNext=True)
+        if x.rval != 0:
+            break
+        print "".join(map(chr, x.rparams['RecordData']))
+        iter_id = x.rparams['IterationIdentifier']
+
+
+Sending new message to log
+--------------------------
+
+Simple example that uses :ref:`LMI_JournalLogRecord.create_instance()<LMI-JournalLogRecord>`
+CIM method to send a new message in the log::
+
+    #!/usr/bin/lmishell
+    c = connect("localhost", "pegasus", "test")
+    c.root.cimv2.LMI_JournalLogRecord.create_instance({"CreationClassName": "LMI_JournalLogRecord",
+                                                       "LogCreationClassName": "LMI_JournalMessageLog",
+                                                       "LogName": "Journal",
+                                                       "DataFormat": ""})
diff --git a/tools/gendoc/doc/index.rst b/tools/gendoc/doc/index.rst
index c1f3892..fb3ade0 100644
--- a/tools/gendoc/doc/index.rst
+++ b/tools/gendoc/doc/index.rst
@@ -21,6 +21,7 @@ Table of Content
    config
    clones/openlmi-providers/src/account/doc/source/index
    clones/openlmi-providers/src/hardware/doc/source/index
+   clones/openlmi-providers/src/journald/doc/source/index
    clones/openlmi-providers/src/logicalfile/doc/source/index
    clones/openlmi-providers/src/realdm/doc/source/index
    clones/openlmi-providers/src/service-dbus/doc/source/index