Downloads:

815

Downloads of v 2.2:

347

Last Update:

04 Oct 2021

Package Maintainer(s):

Software Author(s):

  • DB Solo LLC

Tags:

kafka-tool kafka tool offset explorer offset-explorer

Offset Explorer (Formerly Kafka Tool)

  • 1
  • 2
  • 3

2.2 | Updated: 04 Oct 2021

Downloads:

815

Downloads of v 2.2:

347

Maintainer(s):

Software Author(s):

  • DB Solo LLC

  • 1
  • 2
  • 3
Offset Explorer (Formerly Kafka Tool) 2.2

  • 1
  • 2
  • 3

All Checks are Passing

3 Passing Tests


Validation Testing Passed


Verification Testing Passed

Details

Scan Testing Successful:

No detections found in any package files

Details

Deployment Method: Individual Install, Upgrade, & Uninstall

To install Offset Explorer (Formerly Kafka Tool), run the following command from the command line or from PowerShell:

>

To upgrade Offset Explorer (Formerly Kafka Tool), run the following command from the command line or from PowerShell:

>

To uninstall Offset Explorer (Formerly Kafka Tool), run the following command from the command line or from PowerShell:

>

Deployment Method:

📝 NOTE: This applies to both open source and commercial editions of Chocolatey.

1. Enter Your Internal Repository Url

(this should look similar to https://community.chocolatey.org/api/v2/)


2. Setup Your Environment

1. Ensure you are set for organizational deployment

Please see the organizational deployment guide

2. Get the package into your environment

  • Open Source or Commercial:
    • Proxy Repository - Create a proxy nuget repository on Nexus, Artifactory Pro, or a proxy Chocolatey repository on ProGet. Point your upstream to https://community.chocolatey.org/api/v2/. Packages cache on first access automatically. Make sure your choco clients are using your proxy repository as a source and NOT the default community repository. See source command for more information.
    • You can also just download the package and push it to a repository Download

3. Copy Your Script

choco upgrade offset-explorer -y --source="'INTERNAL REPO URL'" [other options]

See options you can pass to upgrade.

See best practices for scripting.

Add this to a PowerShell script or use a Batch script with tools and in places where you are calling directly to Chocolatey. If you are integrating, keep in mind enhanced exit codes.

If you do use a PowerShell script, use the following to ensure bad exit codes are shown as failures:


choco upgrade offset-explorer -y --source="'INTERNAL REPO URL'" 
$exitCode = $LASTEXITCODE

Write-Verbose "Exit code was $exitCode"
$validExitCodes = @(0, 1605, 1614, 1641, 3010)
if ($validExitCodes -contains $exitCode) {
  Exit 0
}

Exit $exitCode

- name: Install offset-explorer
  win_chocolatey:
    name: offset-explorer
    version: '2.2'
    source: INTERNAL REPO URL
    state: present

See docs at https://docs.ansible.com/ansible/latest/modules/win_chocolatey_module.html.


chocolatey_package 'offset-explorer' do
  action    :install
  source   'INTERNAL REPO URL'
  version  '2.2'
end

See docs at https://docs.chef.io/resource_chocolatey_package.html.


cChocoPackageInstaller offset-explorer
{
    Name     = "offset-explorer"
    Version  = "2.2"
    Source   = "INTERNAL REPO URL"
}

Requires cChoco DSC Resource. See docs at https://github.com/chocolatey/cChoco.


package { 'offset-explorer':
  ensure   => '2.2',
  provider => 'chocolatey',
  source   => 'INTERNAL REPO URL',
}

Requires Puppet Chocolatey Provider module. See docs at https://forge.puppet.com/puppetlabs/chocolatey.


4. If applicable - Chocolatey configuration/installation

See infrastructure management matrix for Chocolatey configuration elements and examples.

Private CDN cached downloads available for licensed customers. Never experience 404 breakages again! Learn more...

This package was approved by moderator jpruskin on 12 Oct 2021.

Description

Kafka Browser

The browser tree in Offset Explorer allows you to view and navigate the objects in your Apache Kafka® cluster -- brokers, topics, partitions, consumers -- with a couple of mouse-clicks. Connections to your Kafka cluster are persisted so you don't need to memorize or enter them every time. You can quickly view information about all your clusters no matter how many you have.

View Messages

You can quickly view messages and their keys in the partitions of your topics. You can select how many messages to view at once and which offset to read messages from. You can view the oldest or newest messages, or you can specify a starting offset where to start reading the messages from. By default Offset Explorer will show your messages and keys in hexadecimal format. However, if your messages are UTF-8 encoded strings, Kafka Tool can show the actual string instead of the regular hexadecimal format.

View Text Data as JSON/XML

If your string-based data is either in JSON or XML format, you can view it in a pretty-printed form in the detail panel of the Data-tab under partitions.

View Consumer Offsets

The browser tree allows you to quickly view all the offsets of your Kafka consumers. The list will show both the start/end offsets of the partitions as well as the offset of consumers within each partition.

You can also view the offsets stored by the Apache Storm's Kafka spouts. Read more

Saving Individual Messages

You can save individual messages to a file on your hard drive using the Save-button in the detail panel of the Data-tab of partitions. The file will contain the bytes of the message as-is. You can also save the key of the message using the same mechanism.

screenshot


tools\chocolateyinstall.ps1
$ErrorActionPreference = 'Stop';

$packageArgs = @{
  packageName   = $env:ChocolateyPackageName

  url           = 'https://www.kafkatool.com/download2/offsetexplorer.exe'
  checksum      = 'bf6182d8342ce51219e71bd1135f16d3c44564d3d6945734d96453bdb961c7bd'
  checksumType  = 'sha256'

  url64bit      = 'https://www.kafkatool.com/download2/offsetexplorer_64bit.exe'
  checksum64    = 'ac2fdff02e69a4e3d27efea8cd629f6360029c3e6df4830f71032154c43f3dc9'
  checksumType64= 'sha256'

  silentArgs    = '-q'
}

Install-ChocolateyPackage @packageArgs
tools\chocolateyuninstall.ps1
$ErrorActionPreference = 'Stop';

$packageArgs = @{
  packageName   = $env:ChocolateyPackageName
  softwareName  = 'Offset Explorer *'
  fileType      = 'exe'
  silentArgs    = '-q'
}

$uninstalled = $false
[array]$key = Get-UninstallRegistryKey -SoftwareName $packageArgs['softwareName']

if ($key.Count -eq 1) {
  $key | % {
    $packageArgs['file'] = "$($_.UninstallString)"
    Uninstall-ChocolateyPackage @packageArgs
  }
} elseif ($key.Count -eq 0) {
  Write-Warning "$packageName has already been uninstalled by other means."
} elseif ($key.Count -gt 1) {
  Write-Warning "$($key.Count) matches found!"
  Write-Warning "To prevent accidental data loss, no programs will be uninstalled."
  Write-Warning "Please alert package maintainer the following keys were matched:"
  $key | % {Write-Warning "- $($_.DisplayName)"}
}

Log in or click on link to see number of positives.

In cases where actual malware is found, the packages are subject to removal. Software sometimes has false positives. Moderators do not necessarily validate the safety of the underlying software, only that a package retrieves software from the official distribution point and/or validate embedded software against official distribution point (where distribution rights allow redistribution).

Chocolatey Pro provides runtime protection from possible malware.

Add to Builder Version Downloads Last Updated Status
Offset Explorer (Formerly Kafka Tool) 2.1 468 Saturday, March 27, 2021 Approved

This package has no dependencies.

Discussion for the Offset Explorer (Formerly Kafka Tool) Package

Ground Rules:

  • This discussion is only about Offset Explorer (Formerly Kafka Tool) and the Offset Explorer (Formerly Kafka Tool) package. If you have feedback for Chocolatey, please contact the Google Group.
  • This discussion will carry over multiple versions. If you have a comment about a particular version, please note that in your comments.
  • The maintainers of this Chocolatey Package will be notified about new comments that are posted to this Disqus thread, however, it is NOT a guarantee that you will get a response. If you do not hear back from the maintainers after posting a message below, please follow up by using the link on the left side of this page or follow this link to contact maintainers. If you still hear nothing back, please follow the package triage process.
  • Tell us what you love about the package or Offset Explorer (Formerly Kafka Tool), or tell us what needs improvement.
  • Share your experiences with the package, or extra configuration or gotchas that you've found.
  • If you use a url, the comment will be flagged for moderation until you've been whitelisted. Disqus moderated comments are approved on a weekly schedule if not sooner. It could take between 1-5 days for your comment to show up.
comments powered by Disqus