-
Notifications
You must be signed in to change notification settings - Fork 296
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
progresslog: Add package documentation.
- Loading branch information
Showing
2 changed files
with
47 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
progresslog | ||
=========== | ||
|
||
[![Build Status](https://github.com/decred/dcrd/workflows/Build%20and%20Test/badge.svg)](https://github.com/decred/dcrd/actions) | ||
[![ISC License](https://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org) | ||
[![Doc](https://img.shields.io/badge/doc-reference-blue.svg)](https://pkg.go.dev/github.com/decred/dcrd/internal/progresslog) | ||
|
||
Package progresslog provides periodic logging for block processing. | ||
|
||
Tests are included to ensure proper functionality. | ||
|
||
## Feature Overview | ||
|
||
- Maintains cumulative totals about blocks between each logging interval | ||
- Total number of blocks | ||
- Total number of transactions | ||
- Total number of votes | ||
- Total number of tickets | ||
- Total number of revocations | ||
- Logs all cumulative data every 10 seconds | ||
- Immediately logs any outstanding data when the provided sync height is reached | ||
|
||
## License | ||
|
||
Package progresslog is licensed under the [copyfree](http://copyfree.org) ISC | ||
License. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
// Copyright (c) 2020 The Decred developers | ||
// Use of this source code is governed by an ISC | ||
// license that can be found in the LICENSE file. | ||
|
||
/* | ||
Package progresslog provides periodic logging for block processing. | ||
Tests are included to ensure proper functionality. | ||
## Feature Overview | ||
- Maintains cumulative totals about blocks between each logging interval | ||
- Total number of blocks | ||
- Total number of transactions | ||
- Total number of votes | ||
- Total number of tickets | ||
- Total number of revocations | ||
- Logs all cumulative data every 10 seconds | ||
- Immediately logs any outstanding data when the provided sync height is reached | ||
*/ | ||
package progresslog |