Pclog

From ProgClub
Revision as of 07:14, 23 February 2017 by John (talk | contribs) (Components: PHPBOM)
Jump to: navigation, search

Pclog is the ProgClub event logger. That's the software we use to log errors that occur in our software so that we can fix them! In addition to the logging components are reporting components. For other projects see projects.

Status

We use semantic versioning. Latest production version: unreleased. Latest development version: 0.1.0.

See tasks for work that still needs to be done.

Motivation

Why this software? The services facilitated by this software allow us to gather detailed error information when problems occur in our production systems. Collecting such information and knowing about problems is the first step in solving the issues.

Administration

Contributors

Members who have contributed to this project. Newest on top.

All contributors have agreed to the terms of the Contributor License Agreement. This excludes any upstream contributors who tend to have different administrative frameworks.

Copyright

Copyright © 2017, Contributors.

License

Licensed under the MIT license.

Components

Libraries, tools, services or media from third parties used under license:

Resources

Downloads

There aren't any downloads yet because we're still under development on our 0.1 version. When we release 1.0 we will (hopefully!) provide tarball packages. Stay tuned.

Source code

The repository can be browsed online:

https://www.progclub.org/pcrepo/pclog/branches/0.1

The latest stable released version of the code will be available from:

https://www.progclub.org/svn/pcrepo/pclog/tags/latest/0.1

Or if you want the latest version for development purposes:

https://www.progclub.org/svn/pcrepo/pclog/branches/0.1

Links

Links are generated with bugslist.php:

$ bugslist --all -a= -c=s -o=sk -t=s > doc/links.wiki

Specifications

Functional specification

The functional specification describes what the project does.

The client software detects events (errors) in software and submits error info to our servers.

The server software collects event information and provides a reporting interface for viewing it.

Technical specification

The technical specification describes how the project works.

TODO: add a bit of a tech-spec.

Notes

See versioning for information on our semantic version numbers.

Notes for implementers

If you are interested in incorporating this software into your project, here's what you need to know:

Grab a recent copy of the code from svn into a lib/pclog-0.1 directory in your project...

TODO: update notes for implementers.

Notes for developers

If you're looking to set up a development environment for this project here's what you need to know:

So you want to hack on Pclog? Cool! Get in touch with John and we'll take it from there!

Notes for ProgClub administrators

To release a version of this project use the pcrepo-branch-release script from the jj5-bin project:

$ pcrepo-branch-release pclog $MAJOR.$MINOR $PATCH

Where:

$MAJOR = the major version number, presently 0
$MINOR = the minor version number, presently 1
$PATCH = the patch number for this release

See status for last production release.

Tasks

TODO

Things to do, in rough order of priority:

  • create a TODO list... :P

Done

Stuff that's done. Latest stuff on top.

  • JE 2017-02-23: created project page
  • JE 2017-02-18: created the project in svn