-
Notifications
You must be signed in to change notification settings - Fork 125
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Print per-second summary statistics detailing a scan, similar to ZMap (…
…#473) * added status handler, needs testing * time formatting * cleanup * fixed leaking ticker found with linter * sanitize out logs for integration tests * remove note * add --quiet and --status-updates-file to cli * revert testing change, just use --quiet flag * add success rate to status handler * pr review, remove rename of file handler * rename Quiet to QuietStatus, more expressive * PR feedback, cleanup output
- Loading branch information
1 parent
87b078f
commit 9a57898
Showing
4 changed files
with
192 additions
and
11 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
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,154 @@ | ||
| /* | ||
| * ZDNS Copyright 2024 Regents of the University of Michigan | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); you may not | ||
| * use this file except in compliance with the License. You may obtain a copy | ||
| * of the License at http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or | ||
| * implied. See the License for the specific language governing | ||
| * permissions and limitations under the License. | ||
| */ | ||
|
|
||
| package iohandlers | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "os" | ||
| "sort" | ||
| "strings" | ||
| "sync" | ||
| "time" | ||
|
|
||
| "github.com/pkg/errors" | ||
| log "github.com/sirupsen/logrus" | ||
|
|
||
| "github.com/zmap/zdns/src/internal/util" | ||
| "github.com/zmap/zdns/src/zdns" | ||
| ) | ||
|
|
||
| type StatusHandler struct { | ||
| filePath string | ||
| } | ||
|
|
||
| type scanStats struct { | ||
| scanStartTime time.Time | ||
| domainsScanned int | ||
| domainsSuccess int // number of domains that returned either NXDOMAIN or NOERROR | ||
| statusOccurance map[zdns.Status]int | ||
| } | ||
|
|
||
| func NewStatusHandler(filePath string) *StatusHandler { | ||
| return &StatusHandler{ | ||
| filePath: filePath, | ||
| } | ||
| } | ||
|
|
||
| // LogPeriodicUpdates prints a per-second update to the user scan progress and per-status statistics | ||
| func (h *StatusHandler) LogPeriodicUpdates(statusChan <-chan zdns.Status, wg *sync.WaitGroup) error { | ||
| defer wg.Done() | ||
| // open file for writing | ||
| var f *os.File | ||
| if h.filePath == "" || h.filePath == "-" { | ||
| f = os.Stderr | ||
| } else { | ||
| // open file for writing | ||
| var err error | ||
| f, err = os.OpenFile(h.filePath, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, util.DefaultFilePermissions) | ||
| if err != nil { | ||
| return errors.Wrap(err, "unable to open status file") | ||
| } | ||
| defer func(f *os.File) { | ||
| if err := f.Close(); err != nil { | ||
| log.Errorf("unable to close status file: %v", err) | ||
| } | ||
| }(f) | ||
| } | ||
| if err := h.statusLoop(statusChan, f); err != nil { | ||
| return errors.Wrap(err, "error encountered in status loop") | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| // statusLoop will print a per-second summary of the scan progress and per-status statistics | ||
| func (h *StatusHandler) statusLoop(statusChan <-chan zdns.Status, statusFile *os.File) error { | ||
| // initialize stats | ||
| stats := scanStats{ | ||
| statusOccurance: make(map[zdns.Status]int), | ||
| scanStartTime: time.Now(), | ||
| } | ||
| ticker := time.NewTicker(time.Second) | ||
| statusLoop: | ||
| for { | ||
| select { | ||
| case <-ticker.C: | ||
| // print per-second summary | ||
| timeSinceStart := time.Since(stats.scanStartTime) | ||
| s := fmt.Sprintf("%02dh:%02dm:%02ds; %d names scanned; %.02f names/sec; %.01f%% success rate; %s\n", | ||
| int(timeSinceStart.Hours()), | ||
| int(timeSinceStart.Minutes())%60, | ||
| int(timeSinceStart.Seconds())%60, | ||
| stats.domainsScanned, | ||
| float64(stats.domainsScanned)/timeSinceStart.Seconds(), | ||
| float64(stats.domainsSuccess*100)/float64(stats.domainsScanned), | ||
| getStatusOccuranceString(stats.statusOccurance)) | ||
| if _, err := statusFile.WriteString(s); err != nil { | ||
| return errors.Wrap(err, "unable to write periodic status update") | ||
| } | ||
| case status, ok := <-statusChan: | ||
| if !ok { | ||
| // status chan closed, exiting | ||
| break statusLoop | ||
| } | ||
| stats.domainsScanned += 1 | ||
| if status == zdns.StatusNoError || status == zdns.StatusNXDomain { | ||
| stats.domainsSuccess += 1 | ||
| } | ||
| if _, ok = stats.statusOccurance[status]; !ok { | ||
| // initialize status if not seen before | ||
| stats.statusOccurance[status] = 0 | ||
| } | ||
| stats.statusOccurance[status] += 1 | ||
| } | ||
| } | ||
| timeSinceStart := time.Since(stats.scanStartTime) | ||
| s := fmt.Sprintf("%02dh:%02dm:%02ds; Scan Complete; %d names scanned; %.02f names/sec; %.01f%% success rate; %s\n", | ||
| int(timeSinceStart.Hours()), | ||
| int(timeSinceStart.Minutes())%60, | ||
| int(timeSinceStart.Seconds())%60, | ||
| stats.domainsScanned, | ||
| float64(stats.domainsScanned)/time.Since(stats.scanStartTime).Seconds(), | ||
| float64(stats.domainsSuccess*100)/float64(stats.domainsScanned), | ||
| getStatusOccuranceString(stats.statusOccurance)) | ||
| if _, err := statusFile.WriteString(s); err != nil { | ||
| return errors.Wrap(err, "unable to write final status update") | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func getStatusOccuranceString(statusOccurances map[zdns.Status]int) string { | ||
| type statusAndOccurance struct { | ||
| status zdns.Status | ||
| occurance int | ||
| } | ||
| statusesAndOccurances := make([]statusAndOccurance, 0, len(statusOccurances)) | ||
| for status, occurance := range statusOccurances { | ||
| statusesAndOccurances = append(statusesAndOccurances, statusAndOccurance{ | ||
| status: status, | ||
| occurance: occurance, | ||
| }) | ||
| } | ||
| // sort by occurance | ||
| sort.Slice(statusesAndOccurances, func(i, j int) bool { | ||
| return statusesAndOccurances[i].occurance > statusesAndOccurances[j].occurance | ||
| }) | ||
| returnStr := "" | ||
| for _, statusOccurance := range statusesAndOccurances { | ||
| returnStr += fmt.Sprintf("%s: %d, ", statusOccurance.status, statusOccurance.occurance) | ||
| } | ||
| // remove trailing comma | ||
| returnStr = strings.TrimSuffix(returnStr, ", ") | ||
| return returnStr | ||
| } |
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
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