varlog

module
v0.22.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 4, 2024 License: Apache-2.0

README

Varlog

ci codecov

Varlog is a strongly consistent distributed log storage. It enables many distributed systems to leverage total-ordered logs to support transactional event processing with high performance, and simplify the building the complex distributed systems.

Installation

With Go module support, add the following import to your code.

import "github.com/kakao/varlog"

Usage

// Open the log.
vlog, _ := varlog.Open(context.Background(), clusterID, mrAddrs)

// Write records to the log.
vlog.Append(context.Background(), topicID, [][]byte{[]byte("hello"), []byte("varlog")})

// Read records from the log.
closer, _ := vlog.Subscribe(context.Background(), topicID, begin, end, func(logEntry varlogpb.LogEntry, err error) {
    fmt.Println(logEntry)
})
defer closer()

License

This software is licensed under the Apache 2 license, quoted below.

Copyright 2022 Kakao Corp. http://www.kakaocorp.com

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this project 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.

Directories

Path Synopsis
cmd
internal
admin
Package admin is a generated GoMock package.
Package admin is a generated GoMock package.
admin/mrmanager
Package mrmanager is a generated GoMock package.
Package mrmanager is a generated GoMock package.
admin/snmanager
Package snmanager is a generated GoMock package.
Package snmanager is a generated GoMock package.
admin/snwatcher
Package snwatcher is a generated GoMock package.
Package snwatcher is a generated GoMock package.
admin/stats
Package stats is a generated GoMock package.
Package stats is a generated GoMock package.
reportcommitter
Package reportcommitter is a generated GoMock package.
Package reportcommitter is a generated GoMock package.
storagenode/client
Package client is a generated GoMock package.
Package client is a generated GoMock package.
pkg
mrc
Package mrc is a generated GoMock package.
Package mrc is a generated GoMock package.
rpc
util/netutil
Package netutil provides helper functions for network.
Package netutil provides helper functions for network.
varlog
Package varlog is a generated GoMock package.
Package varlog is a generated GoMock package.
proto
admpb
Package admpb is a generated GoMock package.
Package admpb is a generated GoMock package.
mrpb/mock
Package mock is a generated GoMock package.
Package mock is a generated GoMock package.
snpb/mock
Package mock is a generated GoMock package.
Package mock is a generated GoMock package.
tests
ee
it

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL